2026-07-06 04:57:23 +00:00
|
|
|
# OpenCode documentation
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
The V2 documentation is a Mintlify site deployed from `packages/docs` on the `dev` branch.
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
## Local preview
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
From this directory, run:
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
```bash
|
2026-07-07 00:09:08 +00:00
|
|
|
bun dev
|
2025-12-05 21:41:35 +00:00
|
|
|
```
|
|
|
|
|
|
2026-07-07 00:09:08 +00:00
|
|
|
The preview opens at `http://localhost:3333` and reloads when MDX or `docs.json` changes.
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
Validate changes before opening a pull request:
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
```bash
|
2026-07-07 00:09:08 +00:00
|
|
|
bun validate
|
|
|
|
|
bun broken-links
|
2026-07-06 04:57:23 +00:00
|
|
|
```
|
2025-12-05 21:42:15 +00:00
|
|
|
|
2026-07-22 22:30:31 +00:00
|
|
|
The V2 theme token reference is generated from
|
|
|
|
|
`packages/tui/src/theme/v2/schema.ts`. Regenerate it after schema changes:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
bun run generate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
`bun validate` checks that the committed snippet is current. The repository's
|
|
|
|
|
generation workflow also refreshes it on pushes to `dev`, so Mintlify always
|
|
|
|
|
receives the generated MDX as part of the published docs tree.
|
|
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
The hosted preview is available at [opencode.mintlify.site](https://opencode.mintlify.site).
|
