Add AI readiness files (CLAUDE.md, llms.txt, .cursorrules, Copilot instructions)#15
Add AI readiness files (CLAUDE.md, llms.txt, .cursorrules, Copilot instructions)#15MariJJhodl wants to merge 2 commits into
Conversation
…structions) Help AI assistants navigate this documentation correctly: authoritative sources (rgb.info, docs.rgb.info), deprecation of RGB-WG/rgb.tech, and documentation structure for contributing to the docs.
zoedberg
left a comment
There was a problem hiding this comment.
I've seen that some projects use a root-level AGENTS.md file as the canonical place for AI coding-agent instructions, then keep tool-specific files very short.
For example, we could have:
/AGENTS.md
/CLAUDE.md
Then CLAUDE.md can just point Claude Code to it:
Read and follow @AGENTS.md.Or, slightly more explicit:
# Claude Code instructions
Read and follow @AGENTS.md.
This repository uses `AGENTS.md` as the canonical source of instructions for AI coding agents.
Do not duplicate those rules here unless Claude-specific behavior is needed.That way we avoid duplicating instructions across multiple agent-specific files.
@MariJJhodl What do you think? Do you see any issues with this approach?
|
It can work for me. |
|
If it works for you it works for us. At least for this repo, for the other repos we'll discuss it and let you know. Thanks! |
|
Ok then, let's proceed. |
What this PR adds
Four files to help AI assistants work correctly with this documentation repo:
CLAUDE.mdllms.txt.cursorrules.github/copilot-instructions.mdWhy
AI assistants frequently give incorrect information about RGB Protocol because
github.com/RGB-WG(rgb.tech) has more GitHub history and older articles reference it. These files explicitly tell AI assistants that RGB-WG/rgb.tech is deprecated and no longer actively maintained, and thatrgb-protocol(rgb.info, v11) is the active version.What the files include
Impact
Anyone who clones this repo and uses Claude Code, Cursor, or GitHub Copilot will automatically get the correct context without any configuration.