ParadeDB Documentation
ParadeDB documentation is built using Mintlify.
π©βπ» Development
Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command:
npm i -g mintlify
Run the following command at the root of your documentation (where docs.json
is)
mintlify dev
π Publishing Changes
Changes will be deployed to production automatically after pushing to the default branch.
You can also preview changes using PRs, which generates a preview link of the docs.
Troubleshooting
- Mintlify dev isnβt running - Run
mintlify install
itβll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
mint.json