Update README.md #8231
Open
Update README.md #8231
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
|
Hi, thanks for the contribution. However, my view is that the README does not need a manual Table of Contents. GitHub already auto-generates a TOC for any Markdown file with multiple headings, which covers all the navigation needs. Here's what it looks like: Since the Gravitino README isn’t excessively long, the built-in navigation is most likely sufficient. Adding a manual TOC would create extra maintenance without adding much value. For longer files like CONTRIBUTING.md, it does make sense to have one. |
justinmclean
reviewed
Sep 3, 2025
| [](https://github.com/SameerSalman29/gravitino/actions) | ||
| [](LICENSE) | ||
| [](https://github.com/SameerSalman29/gravitino/issues) | ||
|
|
There was a problem hiding this comment.
These link to SameerSalman29, we would not add those.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changes were proposed in this pull request?
Added a Table of Contents to improve navigation.
Added front-matter metadata (title/author/date) at the top of the document.
Why are the changes needed?
TOC makes it easier for readers to jump to sections.
Front-matter ensures proper formatting and metadata for the document.
Does this PR introduce any user-facing change?
Only improves readability and navigation; no functional changes.
How was this patch tested?
Verified that TOC links navigate correctly.
Document renders properly with the front-matter included.