This repo generates the docs and setup guide for Onyx found at https://docs.onyx.app/.
It uses Mintlify which is a no-code documentation generation tool. Instructions on setting up local preview are included below.
More info on Mintlify found here.
To make changes, check out mint.json, it should be fairly straightforward hopefully!
Install the Mintlify CLI to preview the documentation changes locally.
To install, use the following command (requires node >= v19.0.0)
npm i -g mintlify
Run the following command at the root of your documentation (where mint.json is)
mintlify dev
Changes are automatically deployed to production after merging to main.
- Mintlify dev isn't running - Run
mintlify installit'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
mint.json - Mintlify Docs - https://mintlify.com/docs/introduction