Improve AGENTS.md accuracy, completeness, and agent efficiency#2225
Draft
nick-inkeep wants to merge 4 commits intomainfrom
Draft
Improve AGENTS.md accuracy, completeness, and agent efficiency#2225nick-inkeep wants to merge 4 commits intomainfrom
nick-inkeep wants to merge 4 commits intomainfrom
Conversation
Major improvements to AI coding agent instructions: - Add Command Timing Guide with iteration flow, hook docs, and CI gaps - Add Hono v4 web framework section with domain mount map - Add package dependency graph (verified against all package.json files) - Add Multi-Agent Framework section with execution model and relation types - Expand Database Architecture with two-DB engine details and Doltgres caveats - Add Skills System section documenting Agent Skills open standard - Expand Database Operations table with all 13 commands and per-DB variants - Replace blanket "ALL work MUST include tests+UI+docs" with change-type matrix - Fix stale patterns: remove nonexistent graph.init(), correct builder guidance - Fix inaccuracies: SQLite->PGlite, --run flag, sub_agents->sub_agent_relations - Fix docs path: /agents-docs/content/docs/ -> /agents-docs/content/ - Add commit message guidance, Work Apps file locations, contextId regex docs Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 3 Skipped Deployments
|
|
Cut content that was duplicated elsewhere in the file or provided no actionable value: - Iteration flow / "Do not" list (covered by command reference) - "What only CI can catch" / changeset responsibilities table - DB ops table rows without unique notes (drop/studio variants) - Testing Patterns subsection (duplicates Testing section) - Feature Development Examples (generic NewFeature skeletons) - Migration db:drop rule (duplicate of DB ops table) - Component sub-sections under mandatory checklist (folded into checklist items with form validation + write-docs references) - "When Working with Agents" filler points - AI Coding Assistant Guidance section (symlink info relocated to Skills System section) Preserved unique information by relocating: - "Don't publish changesets" → blockquote in changeset section - AGENTS.md→CLAUDE.md symlink → blockquote in Skills System - Form validation schemas → enhanced checklist item - write-docs skill reference → enhanced checklist item Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Three QA-verified additions: - setup-dev requires pnpm build first (imports from agents-core/dist/) - .env is not merged on re-run — new vars from .env.example need manual addition - Jaeger debugging commands require setup-dev:optional Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
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.
Summary
Overhauls AGENTS.md to fix factual inaccuracies, fill documentation gaps, and cut redundancy — so AI coding agents spend fewer tokens on stale or repeated instructions and more on correct ones. Every factual claim was verified against the actual codebase using 15+ parallel verification agents. Setup-dev gotchas were QA-tested against both greenfield and brownfield scenarios. Only AGENTS.md is changed (net -34 lines: +162/-196).
Architectural decisions
Verify-then-rewrite, not patch. Each section was evaluated against the codebase for accuracy and rewritten if needed. This caught compound errors (e.g., the original said pre-commit runs
pnpm format— actually pre-push does; pre-commit runslint-staged).Redundancy removal with A/B/C classification. Each proposed cut was classified before applying:
NewFeaturecode skeletons, Testing Patterns subsection duplicating the Testing section).Setup-dev additions QA-tested against 12 items. Each candidate was evaluated from both greenfield (fresh clone) and brownfield (existing dev environment) perspectives. Only 3 of 12 candidates survived — the rest were either self-explanatory via error messages, already documented in
.envcomments, or had no behavioral impact.Tables → lists for 2-column data. Two-column tables converted to plain bullet lists for readability.
Changes
Accuracy fixes
/manage,/run,/evals,/.well-known,/work-apps,/mcp)lint-staged(notpnpm format); pre-push runspnpm format--runflag — corrected: already baked into package test scriptscontent/docs/→content/New sections
Setup-dev gotchas (QA-verified)
pnpm setup-devimports fromagents-core/dist/; requirespnpm buildfirst on fresh clones.envtrap —setup-devdoes not merge new vars from.env.exampleinto an existing.env; features fail silently after pulling changes that add env varspnpm setup-dev:optionalRedundancy removed (~185 lines)
db:droprule (duplicate)Formatting
Corrections to existing content
graph.init()removed (doesn't exist)agents-api, builders in SDK/CLIsub_agents→sub_agent_relationsHow to verify
grep -r "app.route" agents-api/src/createApp.ts→ Hono mount pointscat .husky/pre-commit→lint-staged(notpnpm format)head -15 scripts/setup-dev.js→ imports fromagents-core/dist/ensureEnvFile()inpackages/agents-core/src/setup/setup.ts— pure copy-if-missing, no mergeTest plan
Generated with Claude Code