Skip to content

docs(safe): lead with the one-line install and document update and policy - #8

Merged
paulsenon-r merged 1 commit into
mainfrom
safe/docs-install-flow
Oct 27, 2026
Merged

paulsenon-r merged 1 commit into
mainfrom
safe/docs-install-flow

Conversation

@paulsenon-r

Copy link
Copy Markdown
Collaborator

Problem

Install and update weren't obvious from the repo root: README still carried upstream install/marketing content, and the one-line installer was buried in INSTALL.md.

Change

  • README.md: one-line install + "Update: run it again" in the first screen; short Install / Update / What is different / Policy / Docs sections; removed upstream-only install blocks (t3.codes curl, winget/scoop/brew/deb/AUR).
  • INSTALL.md: leads with the one-liner, then options, inspect-first, manual DMG, troubleshooting (incl. provider CLI detection via Binary path); duplicated update prose removed.
  • POLICY.md: states policy is fixed at build time (no runtime override), how to change it (managed-policy.json + allowlist.json + CHANGELOG), and that releases/installer are tied to this repository.

Verified

install.sh options dry-run in a fake HOME; relative links resolve; t3safe update/doctor exist; egress and dependency scans pass.

Not verified

A real install from the new text; capability descriptions in POLICY.md are unchanged from before.

🤖 Generated with Claude Code

…licy

README now opens with the one-line install and update, a short
what-is-different table and the policy summary. INSTALL.md leads with the
one-liner, then update, options, manual DMG and troubleshooting. POLICY.md
states plainly that policy is baked at build time with no runtime override.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@paulsenon-r
paulsenon-r merged commit e1def1c into main Oct 27, 2026
3 checks passed
@paulsenon-r
paulsenon-r deleted the safe/docs-install-flow branch October 27, 2026 07:45
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