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

Add AI readiness files (CLAUDE.md, llms.txt, .cursorrules, Copilot instructions)#7
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 stars
  • Many older articles and Stack Exchange answers reference RGB-WG
  • AI models trained on this data default to RGB-WG as the authoritative source

These files explicitly tell AI assistants that:

  • RGB-WG (rgb.tech) is deprecated and no longer actively maintained
  • rgb-protocol (rgb.info, v11) is the active, maintained version
  • Authoritative sources are rgb.info, docs.rgb.info, and github.com/rgb-protocol

What the files include

  • Authoritative sources with links (including docs.rgb.info/llms-full.txt for LLM-readable docs)
  • Explanation of why RGB-WG confusion happens and how to avoid it
  • Complete setup sequence: Docker, tool installation, wallet creation
  • Full issuance and transfer workflow with correct commands
  • Key concepts (client-side validation, single-use seals, schema, consignment, AluVM)
  • Reference to README.md for the full step-by-step walkthrough

Impact

Anyone who clones this repo and uses Claude Code, Cursor, or GitHub Copilot will automatically get the correct context without any configuration.

Add CLAUDE.md, llms.txt, .cursorrules and .github/copilot-instructions.md
to help AI assistants use the correct sources for RGB Protocol and understand
how to issue and transfer assets in this sandbox environment.

All files point to rgb.info and docs.rgb.info as authoritative sources and
explicitly flag github.com/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