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

Add readme.md to sub-folders #6779

Closed
5 tasks
ValarDragon opened this issue Jul 19, 2020 · 9 comments · Fixed by #13143
Closed
5 tasks

Add readme.md to sub-folders #6779

ValarDragon opened this issue Jul 19, 2020 · 9 comments · Fixed by #13143
Assignees
Labels
help wanted T:Docs Changes and features related to documentation.

Comments

@ValarDragon
Copy link
Contributor

ValarDragon commented Jul 19, 2020

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

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@ValarDragon ValarDragon added the T:Docs Changes and features related to documentation. label Jul 19, 2020
@fedekunze
Copy link
Collaborator

yeah, agree. At least we should have a doc.go file too

@zramsay
Copy link
Contributor

zramsay commented Dec 10, 2021

relate to #10588

@tac0turtle
Copy link
Member

This has overlap with how the spec folder is written, do you suggest we move the spec readmes to the top level?

@tac0turtle
Copy link
Member

would consider this closed now

@ValarDragon
Copy link
Contributor Author

@marbar3778 for osmosis we decided to move spec README to be top level, and ditch the multi-file spec structure

@alexanderbez
Copy link
Contributor

@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!

@tac0turtle
Copy link
Member

hmm one big file? are you not worried about ending up with a huge file?

@tac0turtle tac0turtle reopened this Aug 17, 2022
@alexanderbez
Copy link
Contributor

alexanderbez commented Aug 17, 2022

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

@tac0turtle
Copy link
Member

If people are fine with this then lets do it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted T:Docs Changes and features related to documentation.
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

5 participants