CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Build Commands

  • Development: mintlify dev - Run the documentation locally
  • Install dependencies: npm i -g mintlify
  • Reinstall dependencies: mintlify install - Use when mintlify dev isn’t running

Style Guidelines

  • File Structure: Follow Mintlify conventions with MDX files organized by topic
  • MDX Content: Use components from /snippets where appropriate
  • Formatting: Maintain consistent indentation (2 spaces) in MDX and JSON files
  • Component Imports: Import components at the top of MDX files
  • Images: Store in /images directory with descriptive filenames
  • Navigation: Update mint.json when adding new pages
  • Custom Components: Define in /snippets directory

Documentation Guidelines

  • Keep code examples concise and focused
  • Include proper imports in code snippets
  • Maintain consistent section structure across similar pages
  • Use Mintlify’s accordion, tab, and card components appropriately