[docs] Refactor AI agent documentation following best practices #76
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
Refactors all AI agent documentation (CLAUDE.md, AGENTS.md, Copilot instructions) to follow industry best practices from https://www.humanlayer.dev/blog/writing-a-good-claude-md.
Changes
1. CLAUDE.md (140 → 81 lines)
Improvements:
file:linereferencesdocs/references2. AGENTS.md (192 → 89 lines)
Improvements:
PolicyPipeline→HttpPipeline,fetchRequest.ts→httpPipeline.ts3. .github/copilot-instructions.md (58 → 51 lines)
Improvements:
4. docs/engineering_standards.md (NEW)
New file:
5. README.md Contributing Section
Updates:
docs/engineering_standards.mdBest Practices Alignment
✅ Concise - All AI docs under 100 lines (CLAUDE.md: 81, AGENTS.md: 89)
✅ Complete - Has WHAT, WHY, and HOW (previously missing WHY)
✅ Current - Uses file:line references instead of stale code snippets
✅ Focused - Removed non-universally-applicable content
✅ Structured - Progressive disclosure via docs/ directory
✅ Appropriate - No "LLM as linter" anti-pattern
✅ Accurate - Fixed factual errors in AGENTS.md
Verification
Manual Testing Performed:
Files to Review:
CLAUDE.md- Claude Code specific guidance (81 lines)AGENTS.md- General AI assistant guidance (89 lines).github/copilot-instructions.md- Copilot guidelines (51 lines)docs/engineering_standards.md- Detailed standards reference (85 lines)README.md- Updated Contributing sectionImpact
Note: This is documentation-only changes with no code modifications.