Documentation site for Stars Components and the plugins built on it, hosted on Mintlify.
Package source lives in those repos. This repo only holds the documentation content and site configuration.
| Path | Content |
|---|---|
docs.json |
Mintlify site config: theme, colors, navigation tabs and groups |
index.mdx |
Custom landing page (styled by style.css) |
documentation/guide/ |
Hand-written guides: features, architecture, commands, environment, plugins, testing, migration |
documentation/packages/ |
One landing page per package |
documentation/api/ |
Generated API reference, one folder per package. Do not edit by hand |
documentation/errors/ |
CLI and configuration error reference |
documentation/changelog/ |
Weekly changelog |
logo/, favicon.svg |
Brand assets |
A new page is only visible once it is listed in the navigation section of docs.json.
Install the Mintlify CLI, then run it from the repo root:
npm install --global mint
mint devThe preview is served at http://localhost:3000 and reloads on every change.
CI runs the same checks on every pull request:
mint format # must leave no diff
mint validate # strict build, fails on broken config or links
pnpm install
pnpm lint # oxlint + oxfmt for JSON and Markdown filesCommit messages and pull request titles follow Conventional Commits. See CONTRIBUTING.md for the full workflow.
Mintlify builds and deploys from main through its GitHub app. There is no separate build or publish step here.