doc: improve table-of-contents organization #16297
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current TOC organization is not really following Sphinx best practices and is resulting in a jumble of articles showing up in the sidebar.
Result of these changes is viewable here: https://qlyoung.net/frr-docs/
Compare to: https://docs.frrouting.org/en/latest/
This change primarily organizes existing articles into three major sections:
The appendix has been left as is, but the TOC now has a caption which has the effect of adding a section separator in the nav sidebar.
In order to make the new structure make sense:
And a couple drivebys: