Merge pull request #193 from revisit-studies/sl/docs

created initial draft for creating libraries

Author: alexsb

docs/designing-studies/plugin-libraries.md

@@ -81,7 +81,46 @@ For example, here we add a new `instruction` to the `mini-vlat` library's `treem
 
 ## Creating your Own Plugins
 
-Beyond the libraries we provide, you can also define your own plugins in your study. See [LibraryConfig](https://revisit.dev/docs/typedoc/interfaces/LibraryConfig/) for the details of how to define plugin libraries.
+Beyond the libraries we provide, you can also define your own plugins in your study. 
+
+A natural starting point for creating libraries is if you find yourself creating components that could be re-used across your own studies, or be shared with the broader community. Let's say you have two custom created components, `A.tsx` and `B.tsx`, and you want to turn them into a plugin library. 
+
+Here is an overview of the folders you will be creating: 
+
+```
+study/
+|- public/
+|  |- basic-questionnaire-study/
+|  |- ...
+|  |- libraries/
+|     |- adaptive-vlat/
+|     |- ...
+|     |- my-plugin/                     <- NEW FOLDER (STEP 2)
+|     |- ...
+|  |- library-adaptive-vlat/
+|  |- ...
+|  |- library-my-plugin/                <- NEW FOLDER (STEP 3)
+|- src/
+|  |- analysis/
+|  |- ... 
+|  |- public/
+|    |- demo-click-accuracy-test/
+|    |- ...
+|    |- libraries/
+|       |- mini-vlat/
+|       |- ... 
+|       |- my-plugin/assets/            <- NEW FOLDER (STEP 1)
+```
+
+Suppose you create a new plugin library called `my-plugin`. 
+
+1. **STEP 1**. Create a folder: `src/public/libraries/my-plugin/assets`.
+    - The components that will make up of your library, e.g., `A.tsx`, `B.tsx` as well as any image or video files that go into these components, will sit in this folder. 
+2. **STEP 2**. Create a folder: `public/libraries/my-plugin`.
+    - Initialize a `config.json` file within this newly created folder. This `config.json` should follow [LibraryConfig](https://revisit.dev/docs/typedoc/interfaces/LibraryConfig/). 
+3. **STEP 3**. Create a folder: `public/library-my-plugin`.
+    - Initialize a `config.json` file within this newly created folder. This config file should follow how a study configuration is typically defined (see [StudyConfig](https://revisit.dev/docs/typedoc/interfaces/StudyConfig/)) for more details. 
+    - A typical practice is to include some introductory information before showcasing the full library. To achieve this, create an `introduction.md` file and place it in `public/library/my-plugin/assets/`. 
 
 We are happy to **accept community contributions for libraries!** If you have a library that you think would be useful for others, please reach out to us and we will help you merge it into our repository.