This page is for anyone editing the RocketLogs docs. The site is built with Mintlify. You can preview changes locally with the Mintlify CLI.

​
Prerequisites

  • Node.js 19 or higher
  • This repo (with a docs.json in the docs directory)

​
Preview locally

1

Install the Mintlify CLI

npm i -g mint
2

Run the preview server

From the docs directory (where docs.json lives), run:
mint dev
Open http://localhost:3000 to view the docs. Edits refresh automatically.

​
Custom port

mint dev --port 3333
If port 3000 is in use, the CLI will try the next available port. To find broken links in the docs: 
mint broken-links

​
Deploying the docs

RocketLogs docs are built and served via your own pipeline (e.g. Docker or static host). Build the site using your configured process; the content is in this repo under the docs/ directory.

​
Troubleshooting

Usually due to an outdated Node version. Try:
  1. npm remove -g mint
  2. Upgrade to Node v19 or higher
  3. npm i -g mint
Delete the Mintlify cache: remove the ~/.mintlify folder, then run mint dev again. (The CLI is still named Mintlify; the docs brand is RocketLogs.)