-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Add readme.md to sub-folders #6779
Comments
yeah, agree. At least we should have a doc.go file too |
relate to #10588 |
This has overlap with how the spec folder is written, do you suggest we move the spec readmes to the top level? |
would consider this closed now |
@marbar3778 for osmosis we decided to move spec README to be top level, and ditch the multi-file spec structure |
Yes, huge fan of this! |
hmm one big file? are you not worried about ending up with a huge file? |
IMO it's fine if you have a ToC up top. E.g. https://github.com/osmosis-labs/osmosis/blob/main/x/gamm/README.md |
If people are fine with this then lets do it. |
Summary
Add README.md to sub-folders on github, that explains what is in the directory, and has a redirect link to any applicable docs / specs.
Problem Definition
When looking at the SDK code, the responsibility of each folder is not immediate. For instance, it is very unclear from just the name, what
/server
or/crypto
are doing. Adding a readme that explains what you expect to see in each folder would be greatly expedite finding code about the SDK infrastructure.Modules
For Admin Use
The text was updated successfully, but these errors were encountered: