Skip to content

chore(docs): delete docs/ except RELEASES; fold essentials into code; trim AGENTS, CONTEXT, README - #151

Merged
jayleaton merged 2 commits into
mainfrom
chore/agent-config-cleanup
Nov 17, 2026
Merged

jayleaton merged 2 commits into
mainfrom
chore/agent-config-cleanup

Conversation

@jayleaton

@jayleaton jayleaton commented Nov 17, 2026 •

Copy link
Copy Markdown
Owner

Rules. Before merge, run what this change needs on its exact head (make check-pr runs it): for Go, make lint test scoped with LINT_DIRS/TEST_PKGS (scripts/affected.sh prints them) or make check-fast, plus the checks of what you touched. Then make ci-local RAN="<what you ran>" posts local-ci and fills "Local verification" with that statement and the head SHA. Never edit that section by hand. The Local verification check, make pr-merge and the staging gate refuse the PR while it is missing, names another head, or differs from what local-ci attested. A new push or rebase needs a new attestation. A reported failure (FAILED=) is final for that head: fix it in a new commit.

Problem

docs/ held 14 topic files (about 4,200 lines plus a 750 KB cover image) that repeated what the code, Make help and lint messages already say, and AGENTS.md (257 lines) and README went stale alongside them. Projects made from the template (WealthyE) have already cut this back.

Fix

  • Delete everything in docs/ except RELEASES.md, including BUILD-PLAN.md, ci-speed.md and cover.png (only README used it).
  • Fold what was still needed into code: the package doc for packages/secrets moves into doc.go and picks up the providers, live rotation, hooks and failure rules; the web config/secrets.go comment lists the steps to add a secret; deploy/platform.yaml, the Make help, check-pr.sh and the lint messages no longer point at deleted pages.
  • Repoint every reference: git grep -nE 'docs/[A-Za-z0-9_-]+\.(md|png)' now returns only docs/RELEASES.md, plus one comment in .gitleaks.toml. The secret scan refuses any change to its own policy inside the PR it scans, so that line needs its own PR. Stale AGENTS.md "<section>" pointers ("Adding a secret", "Dev loop", "Migrations", "Deploy to Railway") are repointed or dropped too.
  • Trim AGENTS.md to WealthyE's structure (about 100 lines), keeping only rules generic to the template. "Where code lives" moves to CONTEXT.md. CONTEXT.md and README are trimmed the same way.

Local verification

Filled by make ci-local, 2026-11-17T08:27:17Z. Never edit this section by hand.

Head 5a913f82faa33561a673150b3384ead73cf2f3f5 · tree dce3b009115c · passed
Attested by JJ Eaton on Studio-01

Ran: make ci-pg (make ci, make check-migrations, release smoke on a throwaway Postgres 18); make actionlint secret-scan; pnpm typecheck, lint, test in apps/mobile-app (pnpm 10.27.0)

🤖 Generated with Claude Code

… trim AGENTS, CONTEXT, README

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jayleaton
jayleaton force-pushed the chore/agent-config-cleanup branch from 393a704 to 715f087 Compare November 17, 2026 08:24
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jayleaton
jayleaton merged commit d03fcfe into main Nov 17, 2026
4 checks passed
@jayleaton

Copy link
Copy Markdown
Owner Author

Authorized by JJ, merged by Doug

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