What is docs CLAUDE.md?

Project instructions for the Miden documentation website, built with Docusaurus, a tool for publishing documentation sites. They describe its directories, commands, technology choices, and rules for links and builds.

Use them when editing Miden docs, builder guides, reference pages, React components, styles, or release assets. They also specify the checks to run before proposing changes.

They help an agent make changes that fit the repository and catch broken documentation before a pull request. The instructions also identify where current and versioned documentation live.

How 0xMiden/docs configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to 0xMiden/docs. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/0xMiden/docs/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/0xMiden/docs

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/0xmiden/docs/claude-md/github.svg)](https://agentmods.dev/instructions/0xmiden/docs/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/0xmiden/docs/claude-md"><img src="https://agentmods.dev/badge/instructions/0xmiden/docs/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/0xmiden/docs/claude-md"><img src="https://agentmods.dev/badge/instructions/0xmiden/docs/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 559 This file is loaded in full into every session.

When invoked 559 The same file — it is already loaded in full.

Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00559	$0.00559
Opus 5.5	$0.00224	$0.00224
Sonnet 5.5	$0.00112	$0.00112
Haiku 4.5	$0.00056	$0.00056

Measured 2mo ago against content hash 1716d0422839, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

docs CLAUDE.md scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

- **Always verify URLs** — `curl -sL -o /dev/null -w "%{http_code}" <url>` before adding/changing links

CLAUDE.md · 48 lines

How it starts

The opening of the file, as written. The whole thing — 48 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Miden Docs — CLAUDE.md

Project

Docusaurus v3 documentation site for the Miden ecosystem. Deployed at docs.miden.xyz.

Key Directories

docs/ — current docs (reference, builder/)
docs/builder/ — developer-facing: tools, develop, get-started, smart-contracts, migration
docs/reference/ — protocol design docs
versioned_docs/ — pinned version snapshots
src/ — custom React components, pages, CSS
static/ — images, assets
.release/release-manifest.yml — version info (read by docusaurus.config.ts)

Commands

npm run build          # Full production build — ALWAYS run before PRing
npm run start          # Dev server with hot reload
npm run typecheck      # TypeScript check
npm run clear          # Clear Docusaurus cache (if builds are stale)
npm run generate:og    # Regenerate static Open Graph images

Rules

Always npm run build before creating PRs — catches broken links and build errors
Always verify URLs — curl -sL -o /dev/null -w "%{http_code}" <url> before adding/changing links
Broken links: onBrokenLinks: "warn" in config — treat warnings as errors for PRs
Math: uses remark-math + rehype-katex for LaTeX
Algolia search is configured

Conventions

Conventional commits: docs:, fix:, feat:
Batch related small fixes into single PRs
PR titles should be descriptive, not just "update docs"
Keep markdown clean: no trailing whitespace, consistent heading levels
Internal links: use relative paths, not absolute URLs
Images go in static/img/ with descriptive names
Open Graph cards: when adding or moving a top-level docs section, update src/utils/ogImages.ts and scripts/generate-og-images.mjs. npm run build runs npm run generate:og first, so include any generated static/img/og/*.png changes in the PR.

Gotchas

versioned_docs/ and versioned_sidebars/ are auto-generated — don't edit manually unless you need to update the versioned_docs release contents
sidebars.ts controls navigation — update when adding/removing pages
Release manifest YAML drives version display — don't edit unless releasing
Some custom components in src/ — check before adding new ones

Read the full file on GitHub · 48 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 48 lines · 559 tokens per session scan A 1716d0422839

Subscribe to this mod's changes

docs CLAUDE.md is an instructions file published in the GitHub repository 0xMiden/docs (11 stars, last pushed 21d ago), licensed MIT. It adds 559 tokens to every session, about $0.0022 per session on Opus 5.5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

docs CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
docs CLAUDE.md0xMiden/docs	Instructions file	11	21d ago	MIT	A	559	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,516	GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	275k	3d ago	MIT	A	4,313	Codex, OpenCode

docs: Instructions file for Claude Code