diff options
| author | Quentin Young <qlyoung@qlyoung.net> | 2024-06-25 13:48:33 -0400 |
|---|---|---|
| committer | Quentin Young <qlyoung@qlyoung.net> | 2024-06-25 13:56:29 -0400 |
| commit | 8ef75009a77718ceda4bb79f7a43cf7577271afa (patch) | |
| tree | ceadaa6b95955825c4c510fcedff701795c6fa33 /doc/user/basics.rst | |
| parent | aeeceef618c454ec40c196fc2c08dfe3329ec3dd (diff) | |
doc: improve table-of-contents organization
The current TOC organization is not really following Sphinx best
practices and is resulting in a jumble of articles showing up in the
sidebar.
This change primarily organizes existing articles into three major
sections:
* Introduction
- Contains system requirements, architecture & design, installation,
basic setup
* Basics
- Covers basic commands, concepts, and some random things that don't
fit elsewhere
* Protocols
- Contains all protocol documentation, and other miscellaneous daemon
docs such as those on Zebra, watchfrr, mgmtd, etc.
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:
* Some content has been lifted up from the "Overview" page into the
index page
* Most content has been pushed down from the "Overview" page into the
"About" page (new)
* BFD's page is now titled "BFD" for consistencty; it was the only one
that had the full protocol name written out in the title
And a couple drivebys:
* BFD's intro description paragraph was rewritten to make more sense
* Old language stating that we publish platform packages on the Github
releases page was removed
* References to source building instructions were consolidated into that
section
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
Diffstat (limited to 'doc/user/basics.rst')
| -rw-r--r-- | doc/user/basics.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/user/basics.rst b/doc/user/basics.rst new file mode 100644 index 0000000000..4504e9893c --- /dev/null +++ b/doc/user/basics.rst @@ -0,0 +1,23 @@ +.. _basics: + +###### +Basics +###### + +.. toctree:: + :maxdepth: 2 + + basic + extlog + vtysh + grpc + filter + routemap + affinitymap + ipv6 + kernel + snmp + scripting + nexthop_groups + + |
