Testing appearance of Docs.

iChun · May 30, 2021 · f5c8f9c · f5c8f9c
1 parent 2358dee
commit f5c8f9c
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 7 deletions.
diff --git a/docs/components/config/EventConfiguration.md b/docs/components/config/EventConfiguration.md
@@ -1,2 +1,18 @@
 Event Configuration
 ===================
+
+## Description
+
+Base file that contains all the objects to filter and act upon a Stream Event.
+
+<br />
+
+## Fields
+
+| Name    | Type                           | Description                                                                                                                                                                                                                                                                                                          | Additional Info                                           |
+| ------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| configs | [Configuration](url.tbd) Array | List of event types and configurations                                                                                                                                                                                                                                                                               |                                                           |
+| init    | [Event](url.tbd) Array         | List of events to execute when this configuration file gets loaded (and when it is reloaded).<br /><br />Only global variables will be passed initially but you can add more variables in each event's conditions and outcomes. All events will be executed, the event's allowsOtherEventsToTrigger isn't used here. |                                                           |
+| type    | String                         | This is to define what type of EventConfiguration this is if pulled from an online source. Set by CCI when you are creating the config, eg: streamlabs/streamelements/chat/etc. Bear in mind that retrieving an online file will override local configs.                                                             | Not seen in the Editor                                    |
+| from    | String                         | This is the online source for this EventConfiguration. Set by CCI.                                                                                                                                                                                                                                                   |                                                           |
+| online  | boolean                        | This configuration file was from an online source.                                                                                                                                                                                                                                                                   | Not seen in the Editor. Transient field, never serialised |
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -38,13 +38,7 @@ nav:
   - Libraries:
     - Still Not The Book Kind: 'libraries/index.md' #No colons in the Title!
   - Components:
-    - Event Configuration & Configuration: 'components/eventconfig.md'
-    - Event: 'components/event.md'
-    - Condition:
-      - Condition: 'components/condition/condition.md'
-    - Outcome:
-      - Outcome: 'components/outcome/outcome.md'
-    - Constants: 'components/constants.md'
+    - Event Configuration: 'components/EventConfiguration.md'
 
 # How to, random mob, random chance, repeat outcome, Math, JSONSafe, two high
 # the differences between SL and SE