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

# Maintain the documentation

> Preview, validate, and extend the Mintlify documentation site.

> For the complete documentation index, see [llms.txt](https://devlookout.com/llms.txt). Markdown versions are available by appending `.md` to page URLs.

The Mintlify site is configured by `docs/docs.json`. Pages are Markdown or MDX files in `docs/`, and the HTTP reference is generated from `docs/openapi.yaml`.

## Preview locally

Run from the documentation directory:

```sh theme={null}
cd docs
npx mint dev --no-open
```

The preview starts at `http://localhost:3000` and reloads as files change.

## Validate

```sh theme={null}
cd docs
npx mint validate
```

Validation checks `docs.json`, navigation paths, MDX syntax, links, and the OpenAPI document.

## Add a page

1. Create a `.mdx` file under `docs/` with `title` and `description` frontmatter.
2. Add its extensionless path to the appropriate group in `docs/docs.json`.
3. Use root-relative links such as `/configuration` for internal navigation.
4. Run `npx mint validate` before opening a pull request.

## Update the HTTP reference

Edit `docs/openapi.yaml` when a versioned route, parameter, request body, response, or permission changes. Endpoint entries in `docs/docs.json` use the exact `METHOD /path` form and must match the OpenAPI operation.

Keep handwritten behavior and security guidance in the overview pages. Keep operation-specific parameters and schemas in the OpenAPI document so generated pages stay consistent.

## Deployment

Connect the repository to a Mintlify project and set the documentation directory to `docs`. Mintlify deploys changes after they reach the configured production branch. Domain configuration and deployment status live in the Mintlify dashboard, not this repository.