docs: streamline agent instructions - #28243
Conversation
…mization # Conflicts: # AGENTS.md # site/AGENTS.md
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 88331ab4bc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. More of your lovely PRs please. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Summary
Streamlines the agent instruction files, cutting per-session token overhead by roughly 65%.
The core design change:
AGENTS.mdno longer@-imports WORKFLOWS.md, package.json, the eight detailed guides, orAGENTS.local.mdinto every session. Guidance moves from guaranteed-in-context to load-on-demand through a routing table, betting that one-line guardrail summaries plus links are enough to make agents pull the right doc when a task needs it.AGENTS.md(251 -> 80 lines): a routing table to the canonical docs in.claude/docs/, the essential command table, and one-line guardrails for the architectural footguns (SQLC workflow plus audit table, OAuth2 error conformance, chatd architecture-doc rule, Swagger annotations,InTxdiscipline, test concurrency, workflowpermissions: {}, mandatory git hooks, commit/PR title format).site/AGENTS.md(364 -> 89 lines): keeps the FE1-FE10 contract summary, TypeScript LSP navigation, pnpm command table, React Compiler boundaries, accessibility rules, and the pre-PRfrontend-reviewrequirement. Drops the generic React tutorial sections that restate framework documentation.playwright-artifacts-naming convention move to.claude/docs/AGENT_FAILURES.md; theReact.useId()rule, thekey={String(booleanState)}remount footgun, date-as-prop Storybook determinism, and the suppression-comment rule (updated fromeslint-disabletobiome-ignoreto match current tooling) move to.claude/docs/FRONTEND_PATTERNS.md.Content reflects current main: the chatd rule says agents leave TODOs and the human PR author writes the architecture doc, and MUI/Emotion are described as removed, not deprecated.
Note for Claude Code users:
CLAUDE.mdsymlinks toAGENTS.md, so detailed workflow docs (hook internals, the new-feature checklist,AGENTS.local.md) are no longer auto-loaded into every session; agents must follow the links.Validation
pnpm exec markdownlint-cli2on all four touched files: 0 errorspnpm exec markdown-table-formatter --checkon all four touched files: passmake lint/emdash: passmake lint/agents: pass