Skip to main content

​
docs-mintlify/CLAUDE.md

Para documentation site powered by Mintlify.

​
Commands

  • mintlify dev — Local preview (install: npm i -g mintlify)
  • mintlify install — Reinstall dependencies if dev fails

​
Project Structure

docs-mintlify/
├── docs.json           # Mintlify config (navigation, metadata)
├── v1/                 # Legacy API docs
├── v2/                 # Current docs
│   ├── introduction/   # Getting started
│   ├── concepts/       # Core concepts
│   ├── walkthroughs/   # Step-by-step guides
│   ├── react/          # React SDK docs
│   ├── react-native/   # React Native docs
│   ├── swift/          # Swift SDK docs
│   ├── flutter/        # Flutter SDK docs
│   ├── vue/            # Vue SDK docs
│   ├── svelte/         # Svelte SDK docs
│   ├── server/         # Server-side docs
│   ├── rest/           # REST API reference
│   ├── references/     # Additional references
│   └── general/        # General info
├── snippets/           # Reusable MDX snippets
└── images/             # Documentation images

​
Writing Guidelines

  • Clarity over cleverness — Write for developers who are new to Para
  • Use code examples liberally; ensure they’re tested and up-to-date
  • Keep paragraphs short (2-3 sentences max)
  • Use headers to make content scannable
  • Include “What you’ll learn” at the start of guides

​
API Environments

  • Production: https://api.getpara.com
  • Beta (public-facing test): https://api.beta.getpara.com
  • Sandbox: Internal only — NEVER reference api.sandbox.getpara.com in public docs
  • Partners use beta as their test environment, not sandbox

​
Validation Checklist

  • Code examples compile/run correctly
  • Links work (no 404s)
  • Images have alt text
  • Navigation in docs.json is correct
  • Preview renders properly with mintlify dev

​
Snippets

Reusable content lives in snippets/. Use them for:
  • Common setup instructions
  • Repeated warnings/notes
  • Shared code blocks across guides