docs: trim README ~80%, de-duplicate with AGENTS.md#31
Merged
Conversation
README was 526 lines, heavily duplicating AGENTS.md (chezmoi internals, secret mechanics, AI-tooling layout) and mirroring the config files (exhaustive mise/OS package tables). Cut to a human quick-start: what it is, install, profiles, recovery, per-machine overrides, day-to-day, brief secrets/tmux/iterm/AI overviews. Internals point to AGENTS.md; tool lists point to dot_config/mise/config.toml.tmpl + .chezmoidata/packages.yaml (the source of truth, no drift). Dropped the TODO section (Done items = git log; deferred items recoverable from history).
The README trim dropped this security-relevant list (OAuth tokens in ~/.claude.json, codex auth.json, etc.) and pointed to AGENTS.md for it — but AGENTS didn't actually have it. Add it to the Codex/Claude section so the README pointer resolves and the never-commit guidance lives in the guide.
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
1 participant
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.
README was 526 lines → 117 (~78% smaller).
Why
Three sources of bloat:
dot_config/mise/config.toml.tmpland.chezmoidata/packages.yaml(the actual source of truth → drift risk).What the trimmed README keeps
What it is · install (both OS) · profiles · recovery · per-machine overrides · day-to-day · brief secrets/tmux/iTerm2/VSCode/AI overviews. Internals link to AGENTS.md; tool lists link to the config files.
Best-practice basis
README stays concise + links out rather than duplicating (freeCodeCamp, jehna/readme-best-practices); roadmap/TODO belongs in issues, not the README.
Deferred TODO items (ssh/kube/aws config tracking, Renovate, CI matrix, p10k note) are recoverable from git history at the pre-trim commit — can file as an issue if worth tracking.