Admin: Documentation Structure #21
Description
Apply a better documentation structure by referring to cosmos-cash before the production level release.
But currently, the farming module spec is frequently changed, so we are prototyping to the PoC level, therefore we plan to write detailed documentation of How-To and Tutorials after the alpha version.
A basic document format or spec doc can be applied in advance, regardless of the direction of the code.
In addition, for quick decision-making and development, the initial Spec will be applied to the Spec without the ADR process, and major changes need to be discussed or decisions after the release will be subject to the ADR process.
/
├── README
├── CONTRIBUTING
├── TECHNICAL-SETUP
├── CODEOWNERS
├── x/
| ├── module_a/
| ├── README
| ├── docs/
| ├── state
| ├── state_transitions
| ├── messages
├── docs/
├── README
├── CODEOWNERS
├── Explanation/
| ├── README
| ├── ADR/
| | ├── README
| | ├── PROCESS
| | ├── adr-template
| | ├── adr-{number}-{desc}
| ├── articles/
| | ├── regulation-litepaper/
| | ├── ARTICLE
| ├── research/
| ├── README
| ├── research_topic/
├── How-To/
| ├── HowToDoSomething/
| ├── HowToDoSomethingElse/
├── Reference/
| ├── README
| ├── GLOSSARY
| ├── MODULES
| ├── use-cases/
| | ├── use-case-A
| | ├── use-case-B
| ├── architecture/
├── Tutorials/
├── Tutorial_1/
├── Tutorial_2/
Ref.