A few suggestions for docs improvement
First of all, protocols description are better kept in separate HTML pages otherwise it's hard to find by some keywords that several protocols have. It's really inconvenient to loose focus when you search something related to OSPF and Find scrolls page to completely different protocol. Second: why is font so tiny? -- End of message. Next message?
On Sat, Jan 26, 2019 at 01:42:04PM +0700, Igor Podlesny wrote:
First of all, protocols description are better kept in separate HTML pages otherwise it's hard to find by some keywords that several protocols have. It's really inconvenient to loose focus when you search something related to OSPF and Find scrolls page to completely different protocol.
Agree, i already thought about making them separate chapters/pages, as protocol documentation is about 2/3 of whole documentation. OTOH, most other protocols have just short documentation, so perhaps only 'big' protocols should get separate chapter.
Second: why is font so tiny?
Seems like the ancient CSS on bird.network.cz sets 80% font size for regular text. I have no idea why. -- Elen sila lumenn' omentielvo Ondrej 'Santiago' Zajicek (email: santiago@crfreenet.org) OpenPGP encrypted e-mails preferred (KeyID 0x11DEADC3, wwwkeys.pgp.net) "To err is human -- to blame it on a computer is even more so."
On 26/01/2019 21:14, Ondrej Zajicek wrote:
Agree, i already thought about making them separate chapters/pages, as protocol documentation is about 2/3 of whole documentation. OTOH, most other protocols have just short documentation, so perhaps only 'big' protocols should get separate chapter.
Would it make sense to update documentation to use restructured text (.rst) format going forward? And mayhaps put it up on bird.readthedocs.io? -Christoffer
participants (3)
-
Hansen, Christoffer -
Igor Podlesny -
Ondrej Zajicek