ParadeDB Documentation

ParadeDB documentation is built using Mintlify.

👩‍💻 Development

Install the Mintlify CLI to preview documentation changes locally. The CLI requires Node.js 20.17 or later.

npm i -g mint

Run the following command from docs/, where docs.json is located:

mint dev

😎 Publishing Changes

Production documentation updates are deployed manually through the Publish ParadeDB (Docs) GitHub Actions workflow. The workflow asks Mintlify to rebuild the configured production branch.

Troubleshooting

  • Local preview is out of sync with the deployed documentation - Run mint update.
  • Page loads as a 404 - Make sure you are running in the docs/ folder that contains docs.json.