[19] add glossary and readme

This commit is contained in:
Nikita Khateev
2023-12-07 20:51:08 +04:00
parent 1567442895
commit 48b6ed1ab8
2 changed files with 18 additions and 0 deletions
+14
View File
@@ -0,0 +1,14 @@
# Docs Editing Readme
#### Build and run the documentation
* Run `npm install` to install the dependencies
* Run `npm run docs` to build the directory
* Run `npm run docs:watch` to run the inner docs website
* Open `https://127.0.0.1:8080/` to see the compiled docs
#### Add a new page
* Create a new file at desired destination or copy a template there
* Add your info to the page
* Add a link to the `docs/modules/ROOT/nav.adoc`
+4
View File
@@ -7,6 +7,10 @@
This is a freeform description of the tasks that this pallet fulfills
== Glossary
* _Term_ -- definition of the term
== Config
* `ConfigType` -- desription of config. Include the possible values if there is a set of them.