Skip to content

Commit

Permalink
Update adr-002-docs-structure.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaobei0715 authored Oct 3, 2024
1 parent eb76b1c commit 333978d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/architecture/adr-002-docs-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ docs/
The files in each sub-folders do not matter and will likely change. What matters is the sectioning:

* `README`: Landing page of the docs.
* `intro`: Introductory material. Goal is to have a short explainer of the Cosmos SDK and then channel people to the resource they need. The [Cosmos SDK tutorial](https://github.com/cosmos/sdk-application-tutorial/) will be highlighted, as well as the `godocs`.
* `intro`: Introductory material. Goal is to have a short explainer of the Cosmos SDK and then channel people to the resources they need. The [Cosmos SDK tutorial](https://github.com/cosmos/sdk-application-tutorial/) will be highlighted, as well as the `godocs`.
* `concepts`: Contains high-level explanations of the abstractions of the Cosmos SDK. It does not contain specific code implementation and does not need to be updated often. **It is not an API specification of the interfaces**. API spec is the `godoc`.
* `clients`: Contains specs and info about the various Cosmos SDK clients.
* `spec`: Contains specs of modules, and others.
Expand Down Expand Up @@ -69,7 +69,7 @@ Accepted
* The `/docs` folder now only contains Cosmos SDK and gaia related material. Later, it will only contain Cosmos SDK related material.
* Developers only have to update `/docs` folder when they open a PR (and not `/examples` for example).
* Easier for developers to find what they need to update in the docs thanks to reworked architecture.
* Cleaner vuepress build for website docs.
* Cleaner suppress build for website docs.
* Will help build an executable doc (cf https://github.com/cosmos/cosmos-sdk/issues/2611)

### Neutral
Expand Down

0 comments on commit 333978d

Please sign in to comment.