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

Is spec document structure still accurate? #13758

Closed
rootulp opened this issue Nov 4, 2022 · 1 comment · Fixed by #13768
Closed

Is spec document structure still accurate? #13758

rootulp opened this issue Nov 4, 2022 · 1 comment · Fixed by #13768

Comments

@rootulp
Copy link
Contributor

rootulp commented Nov 4, 2022

├── spec
│   ├── 01_concepts.md
│   ├── 02_state.md
│   ├── 03_messages.md
│   └── 04_events.md

Is this still the recommended file structure for Cosmos SDK module docs? I can't find a module in this repo that conforms to the first file: https://github.com/cosmos/cosmos-sdk/search?q=01_concepts.md

And it looks like auth, bank, gov all contain a README.md at the root of the module and don't contain a separate specs directory with split files.

@julienrbrt
Copy link
Member

julienrbrt commented Nov 4, 2022

Good find, since 0.47 we've collapsed the specs in one README.md.
Let me update the docs. This one is more up to date: https://github.com/cosmos/cosmos-sdk/blob/main/docs/spec/SPEC-SPEC.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants