Skip to main content
These pages live in the ost-docs repository and are built with Mintlify. Fixing a confusing paragraph is a perfectly good first contribution.

​
Run the docs locally

Prerequisites: Node.js 19 or higher.
1

Install the Mintlify CLI

2

Preview

From the repository root, where docs.json lives:
Your local preview runs at http://localhost:3000.
To use a different port:

​
How the site is organised

A page that isn’t listed in docs.json won’t appear in the navigation, even if the file exists.

​
Updating the API reference

The API reference is generated. Never edit api-reference/openapi.json or the endpoint pages by hand. The source of truth is the API’s own Swagger output.
Then regenerate the endpoint pages:
Each endpoint page is a three-line stub that points Mintlify at an operation in the spec:
Finally, register any newly generated page in the API Reference tab in docs.json. The scraper writes files but doesn’t touch navigation.
/api/auth/* (better-auth) is deliberately absent from the specification. The API’s generator doesn’t see those routes. They’re documented by hand in the API introduction, so keep that page in mind when auth changes.

​
Before you open a pull request

Check that nothing links into a void:

​
Writing conventions

  • Prefer showing the real command or file path over describing it.
  • Don’t document intentions. If the code doesn’t do it yet, don’t write it down.
  • When a convention has exceptions in the codebase, say so; contributors will find them anyway.
  • Use <Note>, <Warning> and <Info> for genuine caveats, not for emphasis.

​
Troubleshooting

Usually an outdated Node version:
  1. npm remove -g mint
  2. Upgrade to Node 19 or higher.
  3. npm i -g mint
Make sure you’re running mint dev from the folder containing docs.json, and that the page is registered in the navigation.
Delete the ~/.mintlify folder and run mint dev again.

​
Deployment

Changes merged to the default branch deploy automatically through the Mintlify GitHub app.