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

The README needs an index #405

Closed
alexrudall opened this issue Dec 12, 2023 · 0 comments
Closed

The README needs an index #405

alexrudall opened this issue Dec 12, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@alexrudall
Copy link
Owner

Is your feature request related to a problem? Please describe.
The README is a bit overwhelming and it's hard to see what in it without reading the whole thing

Describe the solution you'd like

  • A simple index of the main sections near the top
  • Should be clickable to take you the right part of the README
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alexrudall