Repository navigation
Tighten README and docs copy, add routing flow diagram - #155
Closed
dantraynor wants to merge 1 commit into
Closed
dantraynor wants to merge 1 commit into
dantraynor wants to merge 1 commit into
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
#chrome-flatpakanchor from DOCUMENTATION.md resolvesChecklist