docs(readme): rewrite as a beginner landing page, and cut v2.0.0 - #4
Conversation
The README was 500 lines of prose that opened with three ways to rescue a broken desktop. Someone who has never used Linux or GitHub met a wall of text and a rescue plan before they learned what the app was. Restructured along the patterns that beginner-facing projects converge on (Pi-hole, Extension Manager, Warehouse, Linutil, Bluefin, ML4W): a one-line description and a screenshot first, badges, a scannable table of what the app changes, numbered install steps with the requirements check folded away, and everything deep — the fifteen-page tour, the questions people ask, the alternative install routes — behind <details> so the page reads in a minute or explores in ten. Also: - "Why it's safe to try" is now its own section near the top, because it is the reason to try the app at all; the rescue instructions keep a callout at the very top and a full section further down. - New "Your first five minutes", "Getting help" (Discussions, issues, glossary, start-here) and "Helping out" sections. - Uninstalling documents ./install.sh --uninstall instead of asking people to delete files by hand. - No claim changed: every fact, number and honest limit is the one that was there before. Release prep for v2.0.0: version drops the .dev0, the metainfo release becomes stable and dated, and the changelog entry is no longer marked unreleased. Tagging v2.0.0 is what builds the wheel and publishes the GitHub release. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0165p9a9fF1VfbWaQEGD7yYW
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Both checks are red here, and neither failure belongs to this PR:
Both modules carry Proposed patch (untested — I have no runner to prove it on): - - uses: actions/setup-python@v5
- with:
- python-version: "3.12"
...
- name: Install gtheme
run: |
- python -m venv --system-site-packages .venv
+ /usr/bin/python3 -m venv --system-site-packages .venvubuntu-latest's own python3 is 3.12, which satisfies
That job needs a decision about how much of a GNOME install the container should carry, which is more than a README PR should be making. Both of these also block the v2.0.0 release: Generated by Claude Code |
They were borrowed from the beginner-facing projects the rewrite drew on, and they do not fit this one's voice. Headings, the "written for you if" list, the what-it-changes table and the collapsible summaries are plain text again; the three rescue routes are numbered 1., 2., 3. rather than with keycaps. Kept: the ☰ that names the actual menu button in the window, and the arrows in "Settings → System → About", which are part of what the reader is being told to click. Anchors lose the leading hyphen a stripped emoji left in them, here and in the two links from GLOSSARY.md and docs/start-here.md. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0165p9a9fF1VfbWaQEGD7yYW
Brings in the CI restructure from #5 so this PR's checks run against the container job rather than the ubuntu one that could not pass.
The README was 500 lines of prose that opened with three ways to rescue a broken desktop. Someone who has never used Linux or GitHub met a wall of text and a rescue plan before they learned what the app was.
I looked at how projects aimed at people with little Linux/GitHub experience write their front page — Pi-hole, Extension Manager, Warehouse, Linutil, ML4W, Bluefin, WhiteSur, ProtonUp-Qt — and the patterns they share: one-line value proposition and a picture first; badges; short scannable feature lists instead of paragraphs; the simplest install path first with alternatives collapsed; progressive disclosure via
<details>; "recommended" labels; a visible place to ask for help; uninstall documented next to install.What changed
gtheme rescuetip callout and a one-line table of contents.curl | bash" explanation are folded into<details>../install.sh --uninstallrather than asking people to delete files by hand.GLOSSARY.mdanddocs/start-here.mdfollow the renamed anchors.No claim changed: every fact, number, guarantee and honest limit is the one that was already there.
Release prep for v2.0.0
__version__drops the.dev0.type="stable", dated today.Pushing the
v2.0.0tag is what runs.github/workflows/release.yml, builds the wheel and publishes the GitHub release — that is the one remaining step after this merges.Checklist
python -m pytest -qpasses — not run here: this container has no PyGObject or pytest, so CI is the first place the suite runs. The changes are documentation plus a version string, a metainfo date and the changelog.python -m gtheme validate allpasses — same reason.Generated by Claude Code