Commit Graph

4 Commits

Author SHA1 Message Date
Jafar Al-Gharaibeh
fd4a76cb2f doc: fix LaTex warning when building pdf docs
LaTex doesn't like the Unicon character `≥` which should be represented
by the special sequnce `$\leq$`. Since this is buried all in Sphinx, and
we also have a scrip that look for the character, the easiest fix is to
just use `>=` instead which works without warnings, and without asking to
ignore every warning about the use of every instance of the special char.

Signed-off-by: Jafar Al-Gharaibeh <jafar@atcorp.com>
2025-01-13 10:24:12 -06:00
Donatas Abraitis
9fd7ec9551 doc: Add missing RFCs for BGP to the list
* RFC 9687
* RFC 7311

Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-11-07 11:27:48 +02:00
Donatas Abraitis
7b91b0b3ca doc: Add RFC 5701 to the supported RFCs list
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
2024-07-25 11:52:45 +03:00
Quentin Young
8ef75009a7 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>
2024-06-25 13:56:29 -04:00