Add Table of Contents to README - #3005
Open
K-letir-rgb wants to merge 1 commit into
Open
Conversation
Added a Table of Contents section to the README. Signed-off-by: Karen Letir <letirkaren@gmail.com>
Member
|
My initial feedback is the same as in #2655: GitHub already gives us an automatic Table of Contents (just click the hamburger menu) on https://github.com/theupdateframework/python-tuf ... With that in mind I'm not sure we want to add TOC that we have to manually maintain. |
Author
|
That's a fair point, I wasn't aware of the built-in GitHub TOC feature. Given that, would it still be useful to have an inline TOC for people viewing the raw README (e.g. via cat README.md, or a text editor, or in contexts where GitHub's rendering isn't available), or would you rather I close this and look at a different item from the list instead? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of the changes being introduced by the pull request:
Adds a Table of Contents to the README for easier navigation, as suggested in #2654.
This is a small, focused change per @jku's feedback on the earlier PR (#2655) that README improvements should be split into minimal, single-purpose PRs rather than one large combined change. Happy to follow up with separate small PRs for other items from the list if this looks good.
This is a documentation-only change; no tests apply.
Addresses #2654 (partial - table of contents only)