Skip to content

docs(readme): plain English, bullets and numbered steps - #5

Merged
jshvn merged 1 commit into
mainfrom
josh/readme-plain
Sep 25, 2026
Merged

jshvn merged 1 commit into
mainfrom
josh/readme-plain

Conversation

@jshvn

@jshvn jshvn commented Sep 25, 2026

Copy link
Copy Markdown
Member

What

Rewrites the README in plain English. Everything it says is unchanged.

  • The bolded one-liners ("Catch-up is plan, not systemd", "At most once, by writing ahead") are now ordinary sentences.
  • These are now bullet lists:
    • what it does
    • the slot rules
    • the three workflow requirements
    • the retry rules
    • troubleshooting
  • "How it works" is a numbered list of what one tick does, and the diagram uses short plain labels.
  • The setup is five numbered steps, where it used to be five sub-headings.
  • The commands, the slot table, the guarantees and the Nix snippet are unchanged.

Test plan

  • Rendered in the Markdown preview; the mermaid diagram, the table and the code blocks all render
  • Every command and path matches the Taskfile and module.nix

@jshvn
jshvn merged commit c756a85 into main Sep 25, 2026
1 check passed
@jshvn
jshvn deleted the josh/readme-plain branch September 25, 2026 05:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant