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

docs: adopt spec structure in x/payment and x/qgb #330

Closed
Tracked by #514
liamsi opened this issue Apr 15, 2022 · 2 comments · Fixed by #1057
Closed
Tracked by #514

docs: adopt spec structure in x/payment and x/qgb #330

liamsi opened this issue Apr 15, 2022 · 2 comments · Fixed by #1057
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@liamsi
Copy link
Member

liamsi commented Apr 15, 2022

Summary

The readme in https://github.com/celestiaorg/celestia-app/blob/91e35a90c00d49b7fc302f356220d8d830b8fa3b/x/payment/spec/docs.md is a great start. IMO, we should structure this the same way as all sdk modules. This will help auditors and SDK devs understand the modules we are writing.

Also, we must ensure that these docs are and stay up to date (especially as we might add some params like max ODS size etc).

Example: https://github.com/cosmos/cosmos-sdk/tree/e7066c4271ff3d33dc426dc6313c82a1201ae3c6/x/distribution/spec#contents

@liamsi liamsi added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers C: Celestia app labels Apr 15, 2022
@rootulp
Copy link
Collaborator

rootulp commented Nov 4, 2022

It looks like Cosmos SDK modules have migrated away from this spec/* directory structure in favor of a README.md at the root of the module directory (e.g. distribution/README.md). Related cosmos/cosmos-sdk#13758 . To conform with the new style:

x/blob

x/qgb

@rootulp
Copy link
Collaborator

rootulp commented Nov 7, 2022

rootulp added a commit that referenced this issue Nov 23, 2022
0xchainlover pushed a commit to celestia-org/celestia-app that referenced this issue Aug 1, 2024
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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants