docs: add AGENTS.md and llms.txt agent-memory layer (#199)#200
Conversation
There was a problem hiding this comment.
Sorry @w7-mgfcode, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Stands up the AI-agent memory-file layer recommended by the emerging cross-tool standards (closes #199). Four committed files:
AGENTS.md(new) — the universal cross-tool agent brief (open AGENTS.md standard; read by Claude Code, Cursor, Copilot, Gemini CLI, Aider, Zed, …). Plain Markdown, no frontmatter. Holds the shared project context: overview, tech stack, setup, build/test commands, validation gates, architecture & conventions, testing requirements, safety, git/PR conventions, deep-dive doc index.CLAUDE.md(slimmed 116 → 55 lines) — now the thin Claude-specific layer: it@importsAGENTS.md, keeps the@docs/_base/*.mddeep-dive imports, a Safety pointer, Verification, Workflow, and Learnings. No content is duplicated between the two files; shared material lives only in AGENTS.md.llms.txt(new) — repo-root index following the llms.txt convention: H1 + blockquote summary + H2-sectioned links into the docs tree + an## Optionalsection. Relative paths (the repo has no hosted docs site). All links verified to resolve.llms-full.txt(new) — the core docs (README, AGENTS.md, CLAUDE.md, thedocs/_base/suite) inlined for full-context LLM consumption.Verification
wc -l CLAUDE.md→ 55 lines (well under the 150 budget).Makefile,pyproject.toml,frontend/package.json.llms.txtlinks resolve to real paths.Out of scope / notes
managing-agent-memory(AGENTS.md + CLAUDE.md + thedocs/_base/suite; supersedes and replacesw7_generating-claudemd) andmanaging-llms-txt(llms.txt + llms-full.txt)..claude/is gitignored, so those skills are local-only and not part of this PR.uv.lockchange (self-version bump) was deliberately left out of this commit to keep the PR docs-only.Acceptance
AGENTS.mdcreated with repo-verified commandsCLAUDE.md@importsAGENTS.md, no duplicated content, ≤150 linesllms.txt+llms-full.txtfollow the spec format