Skip to content

Tighten README and docs copy, add routing flow diagram - #156

Merged
dantraynor merged 1 commit into
mainfrom
readmeupdate
Oct 22, 2026
Merged

dantraynor merged 1 commit into
mainfrom
readmeupdate

Conversation

@dantraynor

@dantraynor dantraynor commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner

What

Rewrites the README and docs/DOCUMENTATION.md in shorter, plainer prose and collapses the README install section to the quick-install one-liners plus links to the packaging and helper-installation docs. Replaces the PNG marquee hero with a 55 KB SVG flow diagram (text outlined to paths, no embedded font or foreignObject) and adds light/dark routing-modes diagrams under store-assets/artwork for later use.

Why

The README had grown into duplicated install prose that already lives in the packaging docs, and the hero image did not explain how traffic is routed.

How to Test

  • Open README.md on GitHub and confirm the flow diagram renders on both light and dark themes
  • Click every link in the README install and code-signing sections and confirm they resolve
  • Confirm the helper-installation #chrome-flatpak anchor from DOCUMENTATION.md resolves

Checklist

  • Tested in Chrome
  • Tested in Firefox
  • Updated README if needed

Rewrite README and DOCUMENTATION.md in plainer, shorter prose, collapse the
install section to quick-install one-liners plus links to the packaging docs,
and add a lightweight SVG flow diagram (outlined text, no embedded font) as
the README hero. Add light/dark routing-modes diagrams under store-assets/artwork.
@dantraynor
dantraynor merged commit 13c87cb into main Oct 22, 2026
35 of 37 checks passed
@dantraynor
dantraynor deleted the readmeupdate branch October 22, 2026 06:14
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