-
Notifications
You must be signed in to change notification settings - Fork 14.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add table of contents to README for better navigation #364
Add table of contents to README for better navigation #364
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good format :-)
Thanks! I'm glad the format is clear. Let me know if you have any suggestions or further feedback! 😊 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks okay to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Dhie-boop thanks for your contribution! 🚀
GH already provides TOC natively:
Besides that, it's missing subsections.
@jacksonpradolima Thank you for the feedback and the clarification! 😊 I now see that GitHub’s native TOC feature already serves this purpose. Thanks again for reviewing and guiding me! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this could also be merged, into don't see reason not to, basic changes for better readability.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems good to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The original format used ## which is incorrect for linking to headings. In markdown, headings are linked using # followed by the heading text in lowercase, with spaces replaced by hyphens.
Correct version:
1. [Introduction](#1-introduction)
2. [Model Summary](#2-model-summary)
3. [Model Downloads](#3-model-downloads)
4. [Evaluation Results](#4-evaluation-results)
5. [Chat Website & API Platform](#5-chat-website--api-platform)
6. [How to Run Locally](#6-how-to-run-locally)
7. [License](#7-license)
8. [Citation](#8-citation)
9. [Contact](#9-contact)
==
@erickcestari Thanks for pointing this out! I’ve updated the TOC to use the correct Markdown format for linking to headings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seems good
Looking good 👍 |
@mowentian (apologies for commenting on this closed pull) IMHO, the decision to merge was short sighted. This pertains at least to this Organization's repository. cf: DeepSeek_V3.pdf Where the README.md file's 1. Introduction and 2. Model Summary, respectively are based on the .pdf file's Abstract and Introduction, and as html <h1> and <h2> elements', indeed and markdown format As below the ToC has a poor æsthetic, and if this pull were eventually reverted, thereafter might be considered removing the enumeration of the README.md file's sections/subsections. Obviously, enumeration of the README.md file's sections/subsections occurs in [Organization] sibling repositories. DeepSeek-R1
|
What does this PR do?
Why is this change needed?
Checklist:
Let me know if any changes are needed!