-
Notifications
You must be signed in to change notification settings - Fork 101
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
Use doctoc to automatically generate TOCs #2213
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2213 +/- ##
=======================================
Coverage 87.62% 87.62%
=======================================
Files 96 96
Lines 6715 6715
Branches 50 50
=======================================
Hits 5884 5884
Misses 774 774
Partials 57 57 ☔ View full report in Codecov by Sentry. |
Question: when I look at Gateway Fabric docs, I already see a doc-level TOC in the left-hand column, and a page-level TOC in the right-hand column. What's the benefit of this third TOC? |
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 library is looks great !
yep this would just be for developer docs, as you can see this PR is mostly replacing existing TOCs there. |
Thanks for the explanation! Sounds like a great option to add to whatever template/procedure you have to set up READMEs and similar developer docs. info: @nginx-jack |
Proposed changes
Problem: It's hard to write TOCs and keep them up to date
Solution: Use a
doctoc
to that automaticallyChecklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes
If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.