usebruno / bruno

Opensource IDE For Exploring and Testing Api's (lightweight alternative to postman/insomnia)
https://www.usebruno.com/
MIT License
24.93k stars 1.14k forks source link

Add Table of Contents to Readme #2284

Open KameronKeller opened 3 months ago

KameronKeller commented 3 months ago

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: readme_updates

Original: image

Suggested Heading Change: image

andreassiegel commented 3 months ago

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. :(