justinmclean commented on PR #8231: URL: https://github.com/apache/gravitino/pull/8231#issuecomment-3208431751
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: <img width="1016" height="635" alt="image" src="https://github.com/user-attachments/assets/5655f69b-3e37-4d8e-ab8a-a236aa66bec9"; /> 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](https://github.com/apache/gravitino/blob/main/CONTRIBUTING.md), it does make sense to have one. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
