Skip to content

docs(readme): adopt candid local-first product voice#31

Merged
tcballard merged 4 commits into
mainfrom
codex/readme-front-door
Jul 22, 2026
Merged

docs(readme): adopt candid local-first product voice#31
tcballard merged 4 commits into
mainfrom
codex/readme-front-door

Conversation

@tcballard

@tcballard tcballard commented Jul 22, 2026

Copy link
Copy Markdown
Owner

Summary

Implements the README and launch-evidence follow-up to Issue #29.

Adds:

  • a full README rewrite in a direct, candid builder-operator voice
  • a scannable explanation of the filing flow, safety contract, providers, Finder intake, evaluation evidence, and distribution state
  • a reconciled Launch Pack for selected local-only build 0.1.0 (2)
  • current public-link, asset, review-metadata, and submission-gate evidence
  • a deterministic Store-policy preflight that cannot false-fail on a strings | grep -q broken pipe

Scope

Included

  • README product narrative and technical guidance
  • Launch Pack brief, claims, channel, asset, checklist, and handoff records
  • App Review and submission handoff notes
  • current Mac App Store state in docs/distribution.md
  • the App Store binary-policy assertion in script/preflight_app_store.sh

Excluded

  • application code or runtime behavior
  • App Store metadata mutations, pricing choices, privacy attestation, or submission
  • Developer ID/Homebrew release work
  • installed Store-build smoke testing

Product / Architecture Decisions

  • Kept “A drop folder with opinions.” as the established product line.
  • Used “The model proposes; Swift decides” to state the actual authority boundary without marketing gloss.
  • Described the app as local-first while preserving the stricter Store-only claim: Apple on-device processing or same-Mac Ollama, with no remote model route.
  • Removed the warning-first presentation but retained the GitHub artifact’s ad-hoc-signing limitation in Distribution Status.
  • Added claim C07 so “local-only providers” remains distinct from the Store’s “Data Not Collected” privacy claim.
  • Kept the Launch Pack blocked from final readiness until the installed Store build is smoke-tested.
  • Captured binary strings once before policy checks so pipefail cannot reinterpret an early successful grep -q exit as a missing marker.

User-Facing Contract

CLI

All existing commands and exit-code descriptions remain intact, including:

./script/build_and_run.sh
swift build -c release
.build/release/sorting-hat once --dry-run

Human Output

The README now explains the user journey first, keeps limits next to the features they qualify, and labels Store and GitHub distribution states separately.

JSON Output

No changes.

Exit Codes

No runtime changes. The README retains evaluator exit statuses 1 and 2.

Verification

Ran

python3 /Users/tballard/.codex/plugins/cache/tcballard-toolkit/tcballard-toolkit/0.0.13/skills/launch-pack/scripts/check_launch_pack.py launch-pack
python3 /Users/tballard/.codex/plugins/cache/tcballard-toolkit/tcballard-toolkit/0.0.13/skills/launch-pack/scripts/check_launch_pack.py launch-pack --final
python3 /Users/tballard/.codex/plugins/cache/tcballard-toolkit/tcballard-toolkit/0.0.13/skills/readme-front-door/scripts/audit_front_door.py README.md
./script/preflight_app_store.sh
bash -n script/preflight_app_store.sh
git diff --check

Covered

  • structural Launch Pack validation: passed, 6/6 required files, version 0.1.0
  • final Launch Pack validation: intentionally blocked only by the installed-build Store smoke test
  • README title, placeholders, and local front-door paths: passed
  • all remaining README local paths and executable script references: present
  • Ollama, Issue release(macos): ship a Developer ID signed and notarized build #24, Issue release(app-store): ship a sandboxed Mac App Store build #29, support, and privacy links: HTTP 200
  • screenshot and icon SHA-256 values match their provenance records
  • Merge & Tell quality rubric: 13/14, with technical depth intentionally retaining a concision score of 1/2
  • the exact sandboxed App Store archive preflight that failed in CI now passes locally

Review Path

Review the README narrative first, then the claim/channel matrix, launch brief and handoff, release checklist, and distribution status update.

Notes For Reviewer

The Store build is selected but not submitted or published. Pricing, App Privacy, export compliance, content rights, and installed-build verification remain owner-controlled gates.

Lead with the plain-language filing workflow, the Store build's local-only provider boundary, and a genuine product screenshot.

Remove the obsolete above-the-fold warning while retaining detailed distribution caveats in their channel-specific sections.
Reconciles the launch pack with merged PR #30 and selected local-only build 0.1.0 (2).

Records verified public links, uploaded assets, saved review metadata, the README channel, and the remaining owner-controlled submission gates.
Rewrites the full README in a direct builder-operator voice while preserving verified behavior, commands, safety boundaries, evaluation evidence, and channel-specific release status.

Makes the user workflow scannable, distinguishes the local-only Store build from source distribution, and keeps limitations visible without leading with a warning.
@tcballard tcballard changed the title docs(readme): sharpen local-first front door docs(readme): adopt candid local-first product voice Jul 22, 2026
Avoid a pipefail false negative when grep exits after finding a policy string and closes the strings pipeline early.

Capture binary strings once, then run the forbidden-path and required-policy assertions against the completed output.
@tcballard
tcballard merged commit e6b42ef into main Jul 22, 2026
1 check passed
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