From 777dc47692004c94e38b76aaf45ceb2b8d5213fc Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Fri, 27 Aug 2021 20:48:56 +0200 Subject: [PATCH] Wiki: Add more documentation for config parameters Signed-off-by: Knut Ahlers --- wiki/Home.md | 9 ++++++--- wiki/Home.md.tpl | 9 ++++++--- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/wiki/Home.md b/wiki/Home.md index 37fca38..9fce536 100644 --- a/wiki/Home.md +++ b/wiki/Home.md @@ -40,12 +40,15 @@ ```yaml --- -bot_token: '...' # See documentation above -guild_id: '...' # ID of your Discord "server" (internally named "guild") +# See documentation above +bot_token: '...' +# ID of your Discord "server" (internally named "guild") +guild_id: '...' +# File location to store a persistent state for the modules store_location: /path/to/storage.json module_configs: - - id: unique id for the module instance + - id: 'unique id for the module instance (e.g. UUID)' type: module-type attributes: key: value diff --git a/wiki/Home.md.tpl b/wiki/Home.md.tpl index c090875..cdcf31d 100644 --- a/wiki/Home.md.tpl +++ b/wiki/Home.md.tpl @@ -40,12 +40,15 @@ ```yaml --- -bot_token: '...' # See documentation above -guild_id: '...' # ID of your Discord "server" (internally named "guild") +# See documentation above +bot_token: '...' +# ID of your Discord "server" (internally named "guild") +guild_id: '...' +# File location to store a persistent state for the modules store_location: /path/to/storage.json module_configs: - - id: unique id for the module instance + - id: 'unique id for the module instance (e.g. UUID)' type: module-type attributes: key: value