Skip to main content

​
Local preview

Install the Mintlify CLI: 
npm i -g mint
Run the preview server from pkg/docs: 
cd pkg/docs
mint dev
The local preview runs at http://localhost:3000.

​
Content rules for this repo

  • Document what ships now.
  • Put planned features in the roadmap.
  • Keep examples aligned with the current CLI, SDK, and HTTP API.
  • Prefer small examples over screenshots until the UI stabilizes.

​
Checks

Validate links before you push: 
cd pkg/docs
mint broken-links

​
Source of truth

These directories in usebarekey/barekey should drive most public docs updates:
  • pkg/cli
  • pkg/sdk
  • pkg/convex/http.ts
  • docs/design
When product behavior changes, update this repo in the same cycle.