diff --git a/docs/docs/reference/classes/_category_.json b/docs/docs/reference/classes/_category_.json new file mode 100644 index 0000000..f751c33 --- /dev/null +++ b/docs/docs/reference/classes/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Class reference", + "position": 1, + "link": { + "type": "generated-index", + "description": "Reference for globally accessible classes" + } +} diff --git a/docs/docs/reference/basemodule.md b/docs/docs/reference/classes/basemodule.md similarity index 98% rename from docs/docs/reference/basemodule.md rename to docs/docs/reference/classes/basemodule.md index 5dec4a0..0d85803 100644 --- a/docs/docs/reference/basemodule.md +++ b/docs/docs/reference/classes/basemodule.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 2 description: Template for CORE modules --- diff --git a/docs/docs/reference/core.md b/docs/docs/reference/classes/core.md similarity index 100% rename from docs/docs/reference/core.md rename to docs/docs/reference/classes/core.md diff --git a/docs/docs/reference/loggerinstance.md b/docs/docs/reference/classes/loggerinstance.md similarity index 98% rename from docs/docs/reference/loggerinstance.md rename to docs/docs/reference/classes/loggerinstance.md index 26ad967..ff83a3a 100644 --- a/docs/docs/reference/loggerinstance.md +++ b/docs/docs/reference/classes/loggerinstance.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 3 description: Passes `origin` for you. --- diff --git a/docs/docs/reference/types.md b/docs/docs/reference/classes/types.md similarity index 98% rename from docs/docs/reference/types.md rename to docs/docs/reference/classes/types.md index 925cffe..d4bb4df 100644 --- a/docs/docs/reference/types.md +++ b/docs/docs/reference/classes/types.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 1 description: Contains various enums. --- diff --git a/docs/docs/reference/validationschema.md b/docs/docs/reference/classes/validationschema.md similarity index 93% rename from docs/docs/reference/validationschema.md rename to docs/docs/reference/classes/validationschema.md index 42c83c0..d347547 100644 --- a/docs/docs/reference/validationschema.md +++ b/docs/docs/reference/classes/validationschema.md @@ -1,5 +1,5 @@ --- -sidebar_position: 12 +sidebar_position: 5 description: Used for validating multiple CoreValidationSingles. --- diff --git a/docs/docs/reference/validationsingle.md b/docs/docs/reference/classes/validationsingle.md similarity index 99% rename from docs/docs/reference/validationsingle.md rename to docs/docs/reference/classes/validationsingle.md index ad7a3cf..2131848 100644 --- a/docs/docs/reference/validationsingle.md +++ b/docs/docs/reference/classes/validationsingle.md @@ -1,5 +1,5 @@ --- -sidebar_position: 11 +sidebar_position: 4 description: Used for validating data. --- diff --git a/docs/docs/reference/modules/_category_.json b/docs/docs/reference/modules/_category_.json new file mode 100644 index 0000000..83826c0 --- /dev/null +++ b/docs/docs/reference/modules/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Module reference", + "position": 0, + "link": { + "type": "generated-index", + "description": "Reference for CORE modules" + } +} diff --git a/docs/docs/reference/config.md b/docs/docs/reference/modules/config.md similarity index 90% rename from docs/docs/reference/config.md rename to docs/docs/reference/modules/config.md index 2057f4c..95b6214 100644 --- a/docs/docs/reference/config.md +++ b/docs/docs/reference/modules/config.md @@ -1,9 +1,12 @@ --- -sidebar_position: 1 +sidebar_position: 0 description: The framework configuration --- -# `CoreConfiguration` +# Configuration (`config`) +:::warning +Although this is theoretically a class (`CoreConfiguration`), we are counting it as an module as it is used that way during runtime. If you want to create a new configuration class, use `CoreConfiguration.new()`. +::: Provides the default configuration for the CORE Framework. ## Note All settings are variables. diff --git a/docs/docs/reference/erm.md b/docs/docs/reference/modules/erm.md similarity index 99% rename from docs/docs/reference/erm.md rename to docs/docs/reference/modules/erm.md index af89936..35d42d3 100644 --- a/docs/docs/reference/erm.md +++ b/docs/docs/reference/modules/erm.md @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 4 description: Allows for awaited, batched and oneline requests. --- diff --git a/docs/docs/reference/logger.md b/docs/docs/reference/modules/logger.md similarity index 99% rename from docs/docs/reference/logger.md rename to docs/docs/reference/modules/logger.md index 80f0f56..5c687d7 100644 --- a/docs/docs/reference/logger.md +++ b/docs/docs/reference/modules/logger.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 1 description: Your usual basic logger implementation, with some extra features. --- diff --git a/docs/docs/reference/misc.md b/docs/docs/reference/modules/misc.md similarity index 99% rename from docs/docs/reference/misc.md rename to docs/docs/reference/modules/misc.md index de240b5..6e44424 100644 --- a/docs/docs/reference/misc.md +++ b/docs/docs/reference/modules/misc.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 2 description: Contains various utility functions. --- diff --git a/docs/docs/reference/sms.md b/docs/docs/reference/modules/sms.md similarity index 98% rename from docs/docs/reference/sms.md rename to docs/docs/reference/modules/sms.md index ac9a023..436d5e1 100644 --- a/docs/docs/reference/sms.md +++ b/docs/docs/reference/modules/sms.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 3 description: Manages scenes for you efficiently. --- diff --git a/docs/docs/reference/storage.md b/docs/docs/reference/modules/storage.md similarity index 98% rename from docs/docs/reference/storage.md rename to docs/docs/reference/modules/storage.md index b1d4b1c..13b4b3e 100644 --- a/docs/docs/reference/storage.md +++ b/docs/docs/reference/modules/storage.md @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 5 description: Easy config management. --- diff --git a/docs/docs/reference/validation.md b/docs/docs/reference/modules/validation.md similarity index 95% rename from docs/docs/reference/validation.md rename to docs/docs/reference/modules/validation.md index 641fc46..37b977d 100644 --- a/docs/docs/reference/validation.md +++ b/docs/docs/reference/modules/validation.md @@ -1,5 +1,5 @@ --- -sidebar_position: 10 +sidebar_position: 6 description: Allows for data validation. ---