Skip to content

Split README into sphinx doc structured sections#711

Merged
hpk42 merged 37 commits intomainfrom
hpk/chatmail-docs
Nov 11, 2025
Merged

Split README into sphinx doc structured sections#711
hpk42 merged 37 commits intomainfrom
hpk/chatmail-docs

Conversation

@hpk42
Copy link
Contributor

@hpk42 hpk42 commented Nov 1, 2025

The original text from README.md has not been much modified (it was translated using pandoc + some manual formatting fixes).

You can see a rendered version of the draft doc here: https://merlinux.eu/chatmail-docs/

@missytake
Copy link
Contributor

Some thoughts:

The icon could be white in dark mode, maybe https://stackoverflow.com/a/79291623 is enough to fix this?
image

The ToC on index.rst is a bit hard to read, maybe we should adjust the css a bit?

The graphic from architecture.rst would fit well into overview.rst I think :)

I feel like troubleshooting isn't a fitting headline for touch /etc/chatmail-nocreate... maybe we could call it customization and move "Modifying the home page", "Refining the web pages", and "Custom web pages" there, who are right now at getting_started?

@hpk42 hpk42 force-pushed the hpk/chatmail-docs branch from 4415c8a to d3a5060 Compare November 6, 2025 20:07
@hpk42 hpk42 force-pushed the hpk/chatmail-docs branch from 62af895 to c77e5b9 Compare November 7, 2025 15:03
@hpk42 hpk42 changed the title [wip] Split README into sphinx doc structured sections Split README into sphinx doc structured sections Nov 7, 2025
@hpk42 hpk42 requested review from feld, link2xt and missytake November 7, 2025 15:34
@hpk42
Copy link
Contributor Author

hpk42 commented Nov 7, 2025

the intro page has changed completely, also new sectioning since you last looked. See top-level PR description for status.

@hpk42 hpk42 force-pushed the hpk/chatmail-docs branch 5 times, most recently from e72615e to 6598ca8 Compare November 9, 2025 08:28
@missytake
Copy link
Contributor

Sorry, will put my CI commits in #724

@github-actions
Copy link

Check out the page preview at https://staging.chatmail.at/doc/relay/711/

@hpk42 hpk42 force-pushed the hpk/chatmail-docs branch from 1365db1 to a1ab447 Compare November 11, 2025 11:41
Copy link
Contributor

@missytake missytake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Let's iterate over things like darkmode, content, and structure :)

Co-authored-by: missytake <missytake@systemli.org>
@hpk42 hpk42 merged commit 50b986a into main Nov 11, 2025
8 checks passed
@hpk42 hpk42 deleted the hpk/chatmail-docs branch November 11, 2025 13:49
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.

3 participants

Comments