Repository navigation
docs: rewrite the README as a project homepage and sync the docs - #17
Merged
Merged
Conversation
- Lead with what nm-sshuttle is and its features instead of the design status. - Add install from the dnf repository, a quick start and the common setups. - Link the user guide, design, packaging notes and development tools.
- Design: mark the Later items and the editor as implemented, and update the code layout, the .name file and the package notes. - User guide: install nm-sshuttle-gnome from the dnf repository. - VM tests: point to the editor's protocol for the manual GNOME checks.
dennisklein
force-pushed
the
claude/readme-homepage-ry2df2
branch
from
October 11, 2026 20:27
1c5ba6e to
062a930
Compare
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.
Requested by Dennis · project thread
Before: the README opened with a long design-status section, listed the repository's directories and still described the project as a proposal. The design and the other docs lagged behind main (the GNOME editor, the dnf repository, the code layout).
After: the README is a project homepage: what it is and its features, install (dnf repository, other packages, source), a quick start, the common setups, how it works, a documentation index and development notes. The design, user guide and VM test docs agree with main.
The README keeps the first-run material and links the user guide for the full option list. The docs were checked against the code, the specs and the workflows.
How:
README.md: rewritten; no design status.docs/design.md,docs/later/gnome-editor.md: status line, §1, §3 (editor), §4.1 (.namefile), §4.9 (code layout and size) and §7 (Later items, packages, the editor's hand checks) updated.docs/user-guide.md:dnf install nm-sshuttle-gnomefrom the repository.test-vm/README.md: pointed the manual GNOME checks at the editor's protocol (it said there were none).Checked and unchanged: the profile options and defaults, the VM scenario ids and lab tests T1 to T19 against their READMEs, the
docs/lateranddocs/upstreamindexes, and all relative links and anchors in the Markdown.Not claimed: the first v0.1.0 publish to the dnf repository is pending Pages being enabled, so the README's install commands work once it is. The editor's re-check of protocol steps 7.3 to 7.7 in GNOME Settings is still open, as the docs now say.
🤖 Generated with Claude Code