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

# Improve Documentation

Charm docs are built from MDX files under `docs/`.

## Run Docs Locally

From the docs directory:

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
npx mintlify dev
```

Then open the local URL printed in the terminal.

On Windows, enable Developer Mode or run the terminal as Administrator if Mintlify fails to create symlinks.

## File Structure

* `docs/docs.json`: Mintlify configuration and navigation.
* `docs/docs.json` `variables`: substituted in MDX content (for example `{store_url}` in pages).
* Navbar `href` values in `docs.json` must be literal URLs; Mintlify validates them as URIs and does not substitute `{variable}` placeholders there. Keep them in sync with `variables.store_url` and `variables.discord_url`.
* `docs/quickstart`: onboarding.
* `docs/templates`: starter templates.
* `docs/guides`: developer workflow guides.
* `docs/cli`: command reference.
* `docs/platform`: platform features.
* `docs/oss`: contributor and open-source pages.

## Add a Page

1. Create a `.mdx` file.
2. Add frontmatter with `title` and `description`.
3. Add the page path to `docs/docs.json`.
4. Run Mintlify locally.
5. Open a PR.

## Writing Style

* Start with the user goal.
* Use short sections.
* Include copy-pasteable commands.
* Link related pages.
* Avoid hidden assumptions.