OpenStation Docs

A static, searchable documentation site for people who use and build for OpenStation. The current content was checked against repository commit a24da7c0b0d7be0d26ff29b8d525a05dd97dc77a (version 1.1.0) on August 15, 2026.

Live site: openstation-docs.view.fast

The site combines a task-oriented field guide with the repository's full documentation library: user workflows, setup, architecture, APIs, hooks, components, protocols, examples, migrations, test guidance, and internal plans. Product screenshots came from the live WordPress Playground demo and the design follows the visual language of openstation.me.

Writing and interface copy follow the two-audience, plain-language rules in EDITORIAL.md.

Run locally

Node 24 is required.

npm ci
npm run dev

Open the URL Vite prints. To test the production artifact:

npm run check
npm run preview

npm run check type-checks and builds the site, then verifies the content inventory, local Markdown links, screenshots, production entry point, and absence of OpenAI Sites metadata.

Publish to Spacefast

The deployable directory is dist/. After npm run check:

sf publish ./dist

This working copy is linked to Spacefast space openstation-docs; subsequent publishes update the same public site.

See SPACEFAST.md for first-time CLI setup, headers, routing, and a release checklist.

How it is built

• Vite + React; no server runtime and no database.
• Hash-based routes, so deep documentation links do not need a host rewrite rule.
• Markdown is bundled at build time and indexed in the browser for keyboard search.
• Self-hosted Geist and Geist Mono fonts; no font CDN dependency.
• public/_headers supplies Spacefast-compatible security and cache headers.

The generated dist/ folder is disposable. Change the source files, rebuild, and publish the new result.

License

GPL-2.0-or-later, matching OpenStation. See LICENSE.