Skip to main content
This page is for the team and community members contributing to the TruLayer docs. If you’re looking to integrate TruLayer into your app, head to the Quickstart.
Prerequisites:
  • Node.js 19 or higher
  • This repo cloned locally (git clone [email protected]:trulayer/docs.git)

​
Local preview

1

Install the Mintlify CLI

npm i -g mint
2

Start the preview server

From the repo root:
mint dev
The preview is at http://localhost:3000. It hot-reloads as you edit MDX files.

​
Editing content

  • MDX files live at the repo root and in subdirectories (concepts/, sdks/, api-reference/, etc.)
  • Navigation is configured in docs.json — any new page must be listed there to appear in the sidebar
  • Components — Mintlify supports <Card>, <CardGroup>, <Columns>, <Tabs>, <CodeGroup>, <Steps>, <Accordion>, <Note>, <Tip>, <Warning>, <Frame>, and more. See Mintlify’s component reference.

​
Keeping the API reference in sync

The OpenAPI spec is the source of truth for the HTTP API reference. It lives at api-reference/openapi.yaml and is a copy of backend/api/openapi.yaml from the trulayer/backend repo. When the backend spec changes, run: 
cp ../backend/api/openapi.yaml api-reference/openapi.yaml
…and open a PR. CI on the backend repo will flag drift automatically (see TRU-93).

​
Custom ports

mint dev --port 3333

mint broken-links
Run before opening a PR — broken internal links block merge.

​
Deployment

Pushes to main are picked up by the Mintlify GitHub app and deployed to https://docs.trulayer.ai within ~60 seconds.

​
Troubleshooting

This is typically an outdated Node. Try:
  1. npm remove -g mint
  2. Upgrade to Node 19+
  3. npm i -g mint
Remove the local Mintlify cache:
rm -rf ~/.mintlify
mint dev