From 48b6ed1ab8bcaaba21e4d3db1374721ed085beb9 Mon Sep 17 00:00:00 2001 From: Nikita Khateev Date: Thu, 7 Dec 2023 20:51:08 +0400 Subject: [PATCH] [19] add glossary and readme --- docs/README.md | 14 ++++++++++++++ docs/templates/pallet.adoc | 4 ++++ 2 files changed, 18 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..96a8e42 --- /dev/null +++ b/docs/README.md @@ -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` \ No newline at end of file diff --git a/docs/templates/pallet.adoc b/docs/templates/pallet.adoc index be92663..3459788 100644 --- a/docs/templates/pallet.adoc +++ b/docs/templates/pallet.adoc @@ -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.