Documentation development - ToraDB

This page is for documentation contributors editing the site in mdx/. For ToraDB engine development, see Contributing.

Prerequisites

Node.js (for the Mintlify CLI)
The Mintlify CLI: npm i -g mint

Preview locally

From the repository root:

cd mdx
mint dev

Open http://localhost:3000 to preview. The site reloads as you edit .mdx files.

Project layout

Path	Purpose
`docs.json`	Site name, navigation, theme, navbar
`index.mdx`	Home page
`concepts/`	Mental model and on-disk layout
`guides/`	Usage guides
`api-reference/`	Python, SQL, and CLI reference
`community/`	Contributing, security, code of conduct

Deploy

Connect the mdx/ directory to Mintlify via the GitHub app (see your Mintlify dashboard). Pushes to the default branch deploy the published site. After deploy, update the docs URL in the repository docs/README.md and the root README.md.