FRRouting / frr

The FRRouting Protocol Suite
https://frrouting.org/
Other
3.12k stars 1.2k forks source link

doc: improve table-of-contents organization #16297

Closed qlyoung closed 1 week ago

qlyoung commented 1 week ago

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:

qlyoung commented 1 week ago

ci:rerun