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.

Sign up for GitHub

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

Jump to bottom

readme.md isn't helpful and doesn't guide a visitor arriving at neume-network/documents through the various documents in the repository #9

Open
TimDaub opened this issue Jun 17, 2022 · 0 comments
Open

readme.md isn't helpful and doesn't guide a visitor arriving at neume-network/documents through the various documents in the repository #9

TimDaub opened this issue Jun 17, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@TimDaub
Copy link
Contributor

TimDaub commented Jun 17, 2022

  • See current readme.md: https://github.com/neume-network/documents#documents It's practically empty
  • But we should consider that a new users may find this rather confusing. So in the readme, we should outline the repository's purpose, and what the individual documents are.
@TimDaub TimDaub added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@TimDaub