Write and maintain documentation

The website under docs is the canonical documentation source. The standalone starter remains under plugin-creation/starter; the old Markdown guides link readers into this site.

Add or update an article

Use Markdown for prose and code, MDX only when components are needed. Every article needs title and description frontmatter. Put it under the correct audience/category path and add it to the explicit sidebar in astro.config.mjs.

Public articles explain tasks and visible results. Plugin guides focus on the public SDK. Contributor articles explain architecture only where it informs changes.

Link internally using root-relative site paths with trailing slashes. Use real heading anchors, meaningful link labels, and alt text for informative images. Verify claims against current source and tests.

Checked examples

Use a fenced ts api-example block for code that runs inside start(api); the checker provides api and a cleanup disposer array. Use ts plugin-example for a complete module with imports and definePlugin.

The example checker compiles against built public SDK declarations. All TypeScript fences in plugin articles must declare one of these modes, and the required guide examples must remain present.

Run from the project root:

pnpm --filter @fluxplugs/plugin-tools... build
pnpm test:docs
pnpm --dir docs install --frozen-lockfile
pnpm --dir docs build
pnpm --dir docs check:links

Preview and style

Use pnpm –dir docs exec astro dev –background, then status/logs/stop with the same prefix. Theme styles map to the injector’s palette; check dark and light modes, mobile navigation, focus, tables, code blocks, and search.

Docs dependencies use their own lockfile. Production output is static docs/dist, with site URL https://plugs.fluxer.how. Deployment and DNS are managed separately.