From 41501e3d12f99f4cd4fb609af8edc482f04e1ece Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20P=C3=A9rez?= Date: Wed, 14 Aug 2024 18:16:46 +0100 Subject: [PATCH] chore: add docs --- docs/auths.md | 1 + docs/settings.md | 33 +++++++++++++++++++++++++++++++++ docs/static_content.md | 1 + 3 files changed, 35 insertions(+) create mode 100644 docs/auths.md create mode 100644 docs/settings.md create mode 100644 docs/static_content.md diff --git a/docs/auths.md b/docs/auths.md new file mode 100644 index 0000000..5947d18 --- /dev/null +++ b/docs/auths.md @@ -0,0 +1 @@ +# Users authentication and authorizations diff --git a/docs/settings.md b/docs/settings.md new file mode 100644 index 0000000..4608ce9 --- /dev/null +++ b/docs/settings.md @@ -0,0 +1,33 @@ +# Config settings + +This is an example of [configuration file]({{urlbase}}/connfiguration.md) + +Most of settings have default values to "/" for paths or "" for text or false for boolean, if are not set properly {{#include ../globaldefs.md:3}} config loadd will dispplay ain error an will not abort running. + +Attributes order does not matter, in case of file path attributes relative path (the ones ending with path") is tried and finally **root_path** valued as root path for values. Pay attention to **cert** and **key** paths + +Base layout for example below as **config**: + +```text +├── site.toml +├── menu_items.toml +├── serv_paths.toml +└── locales.toml +``` + +## site.toml + +[Site settings]({{urlbase}}/site_settings.md) + +## menu_items.toml + +[Menu Items settings]({{urlbase}}/menu_items_settings.md) + +## serv_paths.toml + +[Serv Paths settings]({{urlbase}}/serv_paths_settings.md) + +## locales.toml + +[Locales settings]({{urlbase}}/locales_settings.md) + diff --git a/docs/static_content.md b/docs/static_content.md new file mode 100644 index 0000000..3d8b31f --- /dev/null +++ b/docs/static_content.md @@ -0,0 +1 @@ +# Static contents