Skip to content

CLAUDE.md

Latest commit

 

History

History
42 lines (36 loc) · 1.88 KB

CLAUDE.md

File metadata and controls

42 lines (36 loc) · 1.88 KB

Miden Docs — CLAUDE.md

Project

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

Key Directories

  • docs/ — current docs (core-concepts, builder/)
  • docs/builder/ — developer-facing: tools, develop, get-started, smart-contracts, migration
  • docs/core-concepts/ — 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)

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

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