Skip to content
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 #289

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Dhie-boop
Copy link

What does this PR do?

  • Adds a table of contents to the README file.
  • Links to all major sections for easy navigation.

Why is this change needed?

  • To improve the user experience for contributors and readers.
  • Makes it easier to find relevant information quickly.

Checklist:

  • Table of contents added with links.
  • Verified that all links work correctly.
  • Proofread for clarity.

Let me know if any changes are needed!

@Dhie-boop
Copy link
Author

Thanks for the feedback.
I understand that 235 lines is manageable to scroll through. However, my intent with these changes was to standardize the layout across the repositories for a consistent user experience.
DeepSeek-V3 repository already uses this style, and I believe it benefits the overall documentation.

I'm open to suggestions, if there's a preferred way to achieve uniformity without the extra layout changes, please let me know. Otherwise, I think this consistency is valuable. Thanks!

@Dhie-boop
Copy link
Author

Thank you for your feedback.
I appreciate your input. Please feel free to close the PR as suggested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants