docs: Restructure README for users; move contributor material to CONTRIBUTING - #29
Merged
Merged
Conversation
README had become a mix of user and contributor material, and several claims had drifted from the code (globe icon, menu mock-up glyphs, fallback reassignment order, "links will never go there"). README is now the user landing doc: why, install, build from source, using it, routing, a new Privacy section, known limitations, uninstall. Every claim was checked against Sources/, Support/Info.plist and install.sh. Architecture, repository layout, project history, releasing and local release testing move to CONTRIBUTING.md with no duplicated text. SECURITY.md now points to README#privacy so the privacy facts live in one place, and assets/README.md drops its stale "not yet wired" section. Docs only; no code, script or workflow changes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The task file is the shared state between agents, so the PR URL is recorded there for the main session and reviewers. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
6 tasks
hexember
added a commit
that referenced
this pull request
Sep 22, 2026
The PR is open against chore/readme-restructure (stacked on #29), so the task file records the link and moves to pr-open as the main session asked. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
hexember
added a commit
that referenced
this pull request
Sep 23, 2026
The PR is open against chore/readme-restructure (stacked on #29), so the task file records the link and moves to pr-open as the main session asked. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Summary
Make
README.mdthe single user-facing landing doc (why, install, use, privacy, limits, uninstall), with every claim checked against the current code. Move contributor-only material intoCONTRIBUTING.mdwithout duplicating anything and without losing any fact. Docs only: no Swift,install.sh, Makefile or workflow changes.What moved where
##, default-browser reset now first), Contributing, Changelog, License.CONTRIBUTING.md: Development (make block, bundle andmake rungotchas, logging snippet), Architecture tree, Repository layout (now withassets/and.github/workflows/), project history and theProject.mddeviations, Testing, Design constraints, Releasing, and a new Testing a release locally section (ACTIVEBROWSER_ZIP/_SUMS/_VERSION).SECURITY.mdWhat the app can see → one-line pointer toREADME.md#privacy. The privacy facts now live in one place.assets/README.md: stale Not yet wired into the bundle replaced by How the bundle uses these.CHANGELOG.md: one[Unreleased]→Changedentry.Stale facts corrected (checked against the code)
Set as Default Browseror a disabled✓ Default Browser. Submenus use✓(no☑/●○).⌘Qon Quit.Recent:is capped at 3 names and readsnone yetwhen empty.httpshandler by name. Every candidate must exist on disk, and the app's own bundle id is dropped from every step./Applicationsonly, opt-out remembered, mixed state opens System Settings), focus history is in memory only, and the.html/.xhtmllow-priority viewer claim.Project.mddeviations: "three places" became "several places, notably these three".assets/README.md: the icons are wired into the bundle (since task 12).Spec checklist
README.md: rewritten to the exact 12-heading outline, with fact corrections F1–F13 applied and contributor sections removed.CONTRIBUTING.md: README's contributor material merged in with no duplicated text, following the target outline (build → gotchas → architecture → layout → history → testing → constraints → PRs → releasing → testing a release locally).SECURITY.md:## What the app can seekept; body replaced with a pointer toREADME.md#privacyafter confirming every old fact is in README Privacy.CHANGELOG.md:[Unreleased]→### Changedentry added.assets/README.md:## Not yet wired into the bundlereplaced by## How the bundle uses these(F16), with "run fromassets/" note above the regeneration commands.Self-verification
mainmake runrow,/tmp/ab.log,two ActiveBrowser rows,log show,is \nil` outside a bundle,git tag,No polling`)globe,☑●○,Not yet wired,three placesbroken: 0;#installand#why-this-exists≥ 1broken: 0, exit 0; #install 2; #why-this-exists 1[Unreleased]entry1; only added lines1; no removed lines.mdfiles + task fileswift buildBuild complete!ldsearch-path lines (known environment noise);Build complete!git diff main -- README.mdTesting notes
Preconditions
README.md→ Display the rendered blob. Read top to bottom, click the platform badge and the Why this exists / Build from source / Install links.✓ Default Browserrow if ActiveBrowser is your default). No developer-only sections remain.CONTRIBUTING.mdandSECURITY.md(rendered).Reset after testing
🤖 Generated with Claude Code