Skip to content

Add AI readiness files (CLAUDE.md, llms.txt, .cursorrules, Copilot instructions) - #7

Open
MariJJhodl wants to merge 1 commit into
rgb-protocol:masterfrom
MariJJhodl:add-ai-readiness-files
Open

MariJJhodl wants to merge 1 commit into
rgb-protocol:masterfrom
MariJJhodl:add-ai-readiness-files

Conversation

@MariJJhodl

Copy link
Copy Markdown
Member

What this PR adds

Four files to help AI assistants work correctly with this repo:

File Tool
CLAUDE.md Claude Code (Anthropic)
llms.txt Open standard — read by various LLM tools and AI crawlers
.cursorrules Cursor
.github/copilot-instructions.md GitHub Copilot

Why

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 that rgb-protocol (rgb.info, v11) is the active version.

What the files include

  • Authoritative sources (rgb.info, docs.rgb.info, docs.rgb.info/llms-full.txt)
  • Schema catalog with production-ready status: NIA, UDA, CFA (production), PFA, IFA (not production-ready)
  • Repository structure (src/, schemata/ with .rgb and .rgba formats)
  • Build commands
  • Key concepts (schema, interface, AluVM, genesis)

Impact

Anyone cloning this repo and using Claude Code, Cursor, or GitHub Copilot will automatically understand the schema catalog and use the correct sources.

…structions)

Help AI assistants understand the schema catalog (NIA, UDA, CFA, PFA, IFA),
use authoritative sources (rgb.info, docs.rgb.info), and correctly identify
RGB-WG/rgb.tech as deprecated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant