Repository navigation
docs: move the guide to AGENTS.md; CLAUDE.md only imports it - #679
Merged
Merged
Conversation
CLAUDE.md held the only guide, which only Claude Code reads. It now lives in AGENTS.md, unchanged apart from the header, and CLAUDE.md is `@AGENTS.md`. ui/AGENTS.md had no CLAUDE.md beside it, so Claude Code never loaded it; ui/CLAUDE.md now imports it (added with -f: `ui/` is in .gitignore, yet its files are tracked). Claude Code still reads the same text through the import, so agent_ab runs see no change in what the agent is given. The README sentence about it now names AGENTS.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request centralizes the AI agent documentation by creating a new AGENTS.md file and updating CLAUDE.md files to reference it. The benchmark documentation is also updated to reflect this change. Feedback on the new AGENTS.md file identifies an inconsistency between the architecture diagram and the FQN example path for IngestionPipeline, suggesting a correction to align the two and better demonstrate the init.py stripping rule.
src/cgis/pipeline.py does not exist; the class is in src/cgis/pipeline/__init__.py, which also shows the __init__ stripping rule the sentence ends on. Pre-existing in CLAUDE.md, caught by review on #679. Co-Authored-By: Claude Opus 5.5 <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.
Why
CLAUDE.mdheld this repo's only agent guide, and only Claude Code reads that file. The workspace target layout, already used in owner-api, ansible (https://github.com/Ownima/ansible/pull/520) and owner-admin (https://github.com/Ownima/owner-admin/pull/212), keeps the text inAGENTS.mdand hasCLAUDE.mdonly import it. That way every agent reads the same text.What
git mv CLAUDE.md AGENTS.md. The text is unchanged apart from the header.CLAUDE.mdis now@AGENTS.md, so Claude Code loads exactly what it loaded before.ui/AGENTS.mdhad noCLAUDE.mdbeside it, so Claude Code never loaded it.ui/CLAUDE.mdnow imports it. It was added with-f:ui/is listed in.gitignore(line 228), yet its files are tracked.AGENTS.md. Past results and lab notes are left as written.Docs only.
🤖 Generated with Claude Code