README: remove TOC in favor to GitHub's TOC #3467
Merged
Conversation
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
Contributor
Author
|
Another approach would be removing TOC because GitHub shows it out of the box: 
See https://github.blog/changelog/2021-04-13-table-of-contents-support-in-markdown-files/ |
Collaborator
|
Since GitHub has this feature by default it's better to drop the self-maintained TOC, because we've to maintain the entries twice, which is error prone. #3469 modified one of the entries. |
Contributor
Author
|
@JoeKar removed TOC, updated PR's description. |
JoeKar
approved these changes
Sep 12, 2024
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.
The PR remove the table of contents because GitHub shows it out of the box.