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

Table Of Contents in README #18055

Open
raghav2005 opened this issue Oct 15, 2024 · 0 comments · May be fixed by #18056
Open

Table Of Contents in README #18055

raghav2005 opened this issue Oct 15, 2024 · 0 comments · May be fixed by #18056
Labels
In-PR This issue has a related PR Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs Needs-Tag-Fix Doesn't match tag requirements Product-Meta The product is the management of the products.
Milestone
Backlog

Comments

@raghav2005
Copy link

I feel as though the README file is quite difficult to navigate and would be much better with the addition of a dropdown Table Of Contents near the beginning which would allow devs/users to skip to the relevant section much more quickly.

I am planning on implementing this myself, so please let me know if this is worth implementing or not.
@raghav2005 raghav2005 added the Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs label Oct 15, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting Needs-Tag-Fix Doesn't match tag requirements labels Oct 15, 2024
@carlos-zamora carlos-zamora linked a pull request Oct 16, 2024 that will close this issue
Open
4 tasks
@carlos-zamora carlos-zamora added Product-Meta The product is the management of the products. and removed Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting Needs-Tag-Fix Doesn't match tag requirements labels Oct 16, 2024
@carlos-zamora carlos-zamora added this to the Backlog milestone Oct 16, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added In-PR This issue has a related PR Needs-Tag-Fix Doesn't match tag requirements labels Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
In-PR This issue has a related PR Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs Needs-Tag-Fix Doesn't match tag requirements Product-Meta The product is the management of the products.
Projects
None yet
Milestone
Backlog
Development

Successfully merging a pull request may close this issue.

Closes #18055 - Updated README with Table Of Contents raghav2005/terminal
2 participants
@carlos-zamora @raghav2005