Skip to main content

Development

This docs site uses Mintlify.

Prerequisites

  • Node.js 18 or newer
  • access to this repo
  • the Mintlify CLI

Local preview

Install the CLI:
npm install -g mint
Run the docs locally from the docs/ directory:
mint dev
If port 3000 is busy, Mintlify will use the next available port.

Useful commands

mint dev --port 3333
mint broken-links

What to check before pushing

  • the overview page reads like a product introduction, not a protocol spec
  • the installation page clearly explains drag-and-drop versus npm install
  • the tool reference matches the actual PIXA tool names
  • the architecture pages leave room for final diagrams and video embeds

Writing style

Keep the docs:
  • short
  • direct
  • human-readable
  • free of old project references
  • free of emoji
The goal is to make the product obvious to a first-time reader.