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

Documentation: Table of Contents #22

Open
tristan-mono opened this issue May 26, 2021 · 0 comments
Open

Documentation: Table of Contents #22

tristan-mono opened this issue May 26, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@tristan-mono
Copy link
Contributor

Context

The Readme for this repo is long and requires a lot of scrolling or searching to find the necessary information.

Problem
It is hard to find the necessary information in the documentation.

Solution
A table of contents at the top can add to the ease of use for the docs. Reading docs should be as fun as writing code.

@umar-abdullahi umar-abdullahi added the documentation Improvements or additions to documentation label May 26, 2021
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
Projects
None yet
Development

No branches or pull requests

2 participants