search

eggheads / eggdrop

The Eggdrop IRC Bot
GNU General Public License v2.0
508 stars 84 forks source link

Update doc #1700

Open michaelortmann opened 1 month ago

michaelortmann commented 1 month ago

Found by: michaelortmann Patch by: michaelortmann Fixes:

One-line summary:

Additional description (if needed):

  1. "Last recently changed" lines like the 1st line in ABOUT doc, is often forgotten and looking at our new shiny html version: https://docs.eggheads.org/about/about.html it looks like this line doesnt belong there, it should be removed and the page should start with the About headline. So this PR removes this cruft above this headline

  2. the sizes of eggdrop install and source tarball have been updated to more likely current values. taken fresh on an x86_64 linux system with du -m.

  3. the rendering of our doc to text files also doesnt work well with lines ending with "-", see: https://github.com/eggheads/eggdrop/blob/277ec01e0aacfc29c8a0ce3383fe1999ca2414ce/doc/ABOUT#L43 v0.7 -v0.9 should be v0.7 - v0.9

  4. this is 1.10 tree, not 1.9: https://github.com/eggheads/eggdrop/blob/277ec01e0aacfc29c8a0ce3383fe1999ca2414ce/doc/ABOUT#L44

  5. update sphinx_source/_themes/agogo/layout.html there was a typo: navigaton fixed it by updating 2 strings to the new ones in upstream sphinx 8.0.2: https://github.com/sphinx-doc/sphinx/blob/v8.0.2/sphinx/themes/agogo/layout.html

  6. typo fixes.

  7. A feature / usability update of the firststeps doc regarding fingerprint and nickserv magick

  8. do not use public / in use ip addresses in doc, instead use the ones given by rfc 3849 and rfc 5737

Test cases demonstrating functionality (if applicable):

michaelortmann commented 1 month ago

What about removing all "Last revised" lines from docs?

What about updating the whole themes folder in eggdrop to the new sphinx version we use? Or did we customize the that theme?

michaelortmann commented 2 weeks ago

Found the following grammar glitch:

https://github.com/eggheads/eggdrop/blob/develop/doc/sphinx_source/about/legal.rst?plain=1#L6C165-L7C1

net.c is by Robey has placed it in the public domain.