Skip to content

Add a TOC to the README#25

Merged
evildmp merged 2 commits intomainfrom
readme-add-toc
Apr 26, 2025
Merged

Add a TOC to the README#25
evildmp merged 2 commits intomainfrom
readme-add-toc

Conversation

@dwilding
Copy link
Collaborator

This PR adds a table of contents to the README. GitHub does generate a TOC, but it's hidden behind a button at the top-right of the README. Adding a TOC as part of the README can help to make the structure more understandable.

You can preview it here: https://github.com/canonical/dashboard/tree/readme-add-toc#dashboard

@dwilding dwilding changed the title add a TOC to the README Add a TOC to the README Apr 25, 2025
@dwilding
Copy link
Collaborator Author

Thanks @mdivo for raising this!

@evildmp evildmp merged commit ec38d05 into main Apr 26, 2025
2 checks passed
@dwilding dwilding deleted the readme-add-toc branch April 27, 2025 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants