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 Table of Contents to Readme #2284

Open
1 task done
KameronKeller opened this issue May 10, 2024 · 1 comment
Open
1 task done

Add Table of Contents to Readme #2284

KameronKeller opened this issue May 10, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@KameronKeller
Copy link
Contributor

I have checked the following:

  • I've searched existing issues and found nothing related to my issue.

Describe the feature you want to add

While reading through the README, I found it challenging to distinguish where one section ended and the next began. This might make it harder for users to find specific information quickly. Additionally, given the length of the README, a Table of Contents would be a valuable addition to help users navigate more efficiently.

To improve the structure and readability of the README, I suggest the following:

  • Add a Table of Contents: This will allow users to jump to different sections quickly and navigate through the content with ease.
  • Adjust the Heading Levels: Consider changing most headings from ### to ##. This creates a clearer separation between sections and adds horizontal lines to indicate where one section ends and the next begins.
  • Introduce Section Hierarchies: If a section contains subtopics, make this hierarchy more explicit. This will improve readability and make the README more intuitive to follow.

Mockups or Images of the feature

Original vs. Suggested Update:
readme_updates

Original:
image

Suggested Heading Change:
image

@andreassiegel
Copy link
Contributor

Hi @KameronKeller,

does GitHub's built-in sort-of table of contents help?

At the top-right above the actual README content, you find an icon that opens a menu that helps navigate the README:

image

I see you also raised a pull request but I'm not sure about the chances of getting it merged anytime soon, given that there are almost 200 open pull requests without any progress. :(

helloanoop pushed a commit that referenced this issue Aug 27, 2024
* Add table of contents and change heading types

* Revert language section

* Move table of contents and delete first two entries

* Fix broken links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants