Skip to content

docs: add CLAUDE.md/AGENTS.md guidance to AI tooling page#20975

Open
critesjosh wants to merge 1 commit intonextfrom
docs/ai-tooling-claude-md-guidance
Open

docs: add CLAUDE.md/AGENTS.md guidance to AI tooling page#20975
critesjosh wants to merge 1 commit intonextfrom
docs/ai-tooling-claude-md-guidance

Conversation

@critesjosh
Copy link
Contributor

Summary

  • Adds a "Project-level instructions" section to the AI tooling docs page recommending developers create CLAUDE.md / AGENTS.md files in their Aztec projects
  • Includes a copy-paste template with the critical aztec compile vs nargo compile distinction
  • Explains why LLMs default to nargo and how project-level instructions fix this
  • Applied to both nightly source and devnet.2 versioned docs

Context

AI tools consistently confuse nargo compile with aztec compile because training data heavily favors standalone Noir tooling. MCP servers and skills help but don't always trigger at the right time. Project-level instruction files (CLAUDE.md, AGENTS.md) are read automatically at conversation start, making them the most reliable fix.

Test plan

  • Verify docs build with yarn build in docs/
  • Review rendered page at /developers/ai_tooling

Add a section recommending project-level instruction files to prevent
LLMs from using nargo compile/test instead of aztec compile/test.
Includes a copy-paste template and explanation of the training data gap.

Applied to both nightly source and devnet.2 versioned docs.
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