Maintain and publish the docs

Local workflowCopy Anchor Link

From the repository root:

cd website
npm ci
npm run dev

npm run verify

Verification checks types, renders every page, validates links and anchors, and tests the exported search index with the real client. CI runs the same checks on documentation PRs.

Screenshots open at full size when selected. Platform and shell tabs keep each set of commands together; code blocks support copying.

Writing conventionsCopy Anchor Link

Keep the README as a practical entry point with runnable examples. The site follows Diátaxis: tutorials, task guides, reference and explanation.

• Keep paragraphs short; use steps for tasks and tables for comparisons.
• Put source dates, coverage and missing-data rules beside the affected feature.
• Label illustrative IDs and fixture screenshots.
• Preserve release and verification reports as dated evidence.

DesignCopy Anchor Link

The docs use the original Steam olive palette from ui/style.css.

Controls have square edges. Navigation works on desktop and mobile, with visible keyboard focus and reduced-motion support. No remote fonts or assets are required.

Build and hostCopy Anchor Link

npm ci
npm run verify

The site is hosted on vapora.micr.dev through GitHub Pages. It documents the local app; the Steam scanner runs locally.

1. The documentation workflow verifies PR changes.
2. On main, it uploads the checked website/out/ artifact.
3. The github-pages environment deploys after a successful build. Manual runs are also available through Actions.

The static export needs no Steam key or application server.

Implementation referencesCopy Anchor Link

• Fumadocs Next.js installation
• Fumadocs MDX integration
• Fumadocs static export
• Built-in static search
• Fumadocs theme variables
• Diátaxis documentation framework
• Steam application context
• kagi-cli README