Add consolidated AGENT.md for faster AI agent onboarding#174
Open
Add consolidated AGENT.md for faster AI agent onboarding#174
Conversation
Replaces the pattern of agents needing to read 3+ narrative prose files with a single scannable reference. setup.sh now offers to wire CLAUDE.md in user projects so agents auto-discover 5DayDocs conventions. https://claude.ai/code/session_01EkKMhGhVEd8VvLrErSdftB
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
2 participants
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
src/docs/5day/AGENT.md— Single, scannable reference (~75 lines) that replaces agents needing to read 3 separate narrative prose files. Covers structure, rules, naming, commands, and task format in one place.CLAUDE.md— Dev repo agent context so contributors using Claude Code get oriented immediately.setup.sh— Now copies AGENT.md to user projects, and offers to create/update the user's CLAUDE.md with a one-liner pointing to it.The problem
AI agents working in a project with 5DayDocs installed had to discover and read 3 files in
docs/5day/ai/(task-writing-rules.md, task-creation.md, feynman-method.md) — all written as narrative prose. That's 3 tool calls and ~9KB of context before an agent could do anything useful. For a lightweight protocol, that's too heavy.The fix
One dense file (
docs/5day/AGENT.md) gives agents everything they need in a single read. The existing protocol files remain as supplementary deep-reads for specific workflows, but are no longer required for routine task management.setup.shnow also offers to wire a CLAUDE.md one-liner so Claude Code auto-discovers 5DayDocs conventions on session start — zero exploration needed.Test plan
./setup.sh .and verify AGENT.md is copied todocs/5day/./setup.sh /tmp/test-projecton a fresh directory and verify CLAUDE.md creation prompt appearsdocs/5day/ai/*.mdfiles still ship unchangedhttps://claude.ai/code/session_01EkKMhGhVEd8VvLrErSdftB