Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc #1700

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
Open

Update doc #1700

wants to merge 10 commits into from

Conversation

michaelortmann
Copy link
Member

@michaelortmann michaelortmann commented Oct 16, 2024

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:

    v0.7 -v0.9 before finally going 1.0. This version of Eggdrop is part

    v0.7 -v0.9 should be v0.7 - v0.9

  4. this is 1.10 tree, not 1.9:

    of the 1.9 tree. A valiant effort has been made to chase down and

  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
Copy link
Member Author

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 michaelortmann force-pushed the doc2 branch 2 times, most recently from d7cdb30 to 7ed5a2a Compare October 16, 2024 13:26
michaelortmann added a commit to michaelortmann/eggdrop that referenced this pull request Oct 21, 2024
@michaelortmann
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant