Skip to content

Conversation

@yeahdongcn
Copy link
Collaborator

Make sure to read the contributing guidelines before submitting a PR

This PR adds a TOC to docs and makes minor updates to build.md.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 16, 2025
@yeahdongcn yeahdongcn changed the title Add table of contents for docs [doc] Add table of contents for docs Mar 16, 2025
@ngxson
Copy link
Collaborator

ngxson commented Mar 18, 2025

IMO we should not add TOC manually because it's often not maintained and being outdated. Github's markdown viewer already render this, just click on the top-right button:

image

@yeahdongcn
Copy link
Collaborator Author

IMO we should not add TOC manually because it's often not maintained and being outdated. Github's markdown viewer already render this, just click on the top-right button:

image

Good to know! I'll go ahead and drop this one.

@yeahdongcn yeahdongcn closed this Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants