Skip to main content

​
Preview before you push

Run the docs locally from the repository root, where docs.json lives.
1

Install or use the Mintlify CLI

npx mint dev
If you want the CLI available globally, install it once with npm i -g mint and use mint dev afterward.
2

Open the local preview

Mintlify serves the docs at http://localhost:3000 by default.
3

Edit and reload

Update .mdx files, docs.json, or SVG assets. The preview refreshes automatically.

​
Useful commands

# Start the local preview
npx mint dev

# Use a different port if 3000 is busy
npx mint dev --port 3333

# Validate internal links
npx mint broken-links

​
Where to pull source content from

While the docs are being migrated, use the LearnTerms app repo as your reference:
  • Product copy and current docs: /Users/justindang/learnterms/src/routes/docs
  • Route structure and UI behavior: /Users/justindang/learnterms/src/routes
  • Shared naming and product concepts: /Users/justindang/learnterms/README.md

​
Writing guidelines

  • Prefer the terms already used in the LearnTerms app.
  • Explain the real workflow before implementation detail.
  • Keep headings practical and user-centered.
  • Use screenshots only when the UI flow would otherwise be ambiguous.