> ## Documentation Index
> Fetch the complete documentation index at: https://toradb.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Documentation development

> Preview and edit the Mintlify docs site locally

This page is for **documentation contributors** editing the site in [`mdx/`](https://github.com/sophatvathana/toradb/tree/main/mdx). For ToraDB engine development, see [Contributing](/community/contributing).

## Prerequisites

* [Node.js](https://nodejs.org/) (for the Mintlify CLI)
* The Mintlify CLI: `npm i -g mint`

## Preview locally

From the repository root:

```bash theme={null}
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](https://mintlify.com) 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`](https://github.com/sophatvathana/toradb/blob/main/docs/README.md) and the root [`README.md`](https://github.com/sophatvathana/toradb/blob/main/README.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.