You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Original:
Suggested Heading Change:
The text was updated successfully, but these errors were encountered:
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:
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. :(
I have checked the following:
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:
Mockups or Images of the feature
Original vs. Suggested Update:
Original:
Suggested Heading Change:
The text was updated successfully, but these errors were encountered: