Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Admin: Documentation Structure #1

Closed
dongsam opened this issue Jul 21, 2021 · 0 comments
Closed

Admin: Documentation Structure #1

dongsam opened this issue Jul 21, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation Epic
Milestone

Comments

@dongsam
Copy link
Contributor

dongsam commented Jul 21, 2021

Apply a better documentation structure by referring to cosmos-cash before the production level release.

But currently, the tax 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.

https://github.com/allinbits/cosmos-cash/blob/main/docs/Explanation/ADR/adr-002-docs-structure.md

@dongsam dongsam added the documentation Improvements or additions to documentation label Jul 21, 2021
@dongsam dongsam added this to the v1 milestone Jul 27, 2021
@dongsam dongsam added the Epic label Jul 30, 2021
@dongsam dongsam changed the title Update Spec doc with Apply better Documentation Structure Admin: Documentation Structure Sep 24, 2021
@jaybxyz jaybxyz closed this as completed Jan 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Epic
Projects
None yet
Development

No branches or pull requests

2 participants