Documentation site for OHS Player, the cross-stack reference toolkit for Open Health Stack, built with Docusaurus.
The site covers how to evaluate, run, configure, and extend the Player reference components. It does not duplicate the wider OHS component catalogue — the OHS Foundation projects page owns that, and each component repository owns its own build commands, API detail, and releases.
docs/ Markdown content, one directory per section
src/ The site shell: components, theme, CSS
sidebars.js The information architecture, defined explicitly
tools/ Quality gates and the route contract
contributing/ Templates for component maintainers submitting content
Requires Node 24.18.0 and npm 11.16.0, which the quality gates check exactly.
npm install
npm startThis serves the site at http://localhost:3000/ohs-docs/ with live reload.
All three run on every pull request. They are pure Node — no browser, no external network — so a full run takes seconds. Deployment re-runs validate and check:build.
npm run validate # frontmatter, route contract, status language, alt text, heading order
npm run check:build # production build, with broken links failing the run
npm run smoke:paths # every route renders its expected content and search indextools/routes.json is the route contract: the list of paths that must exist. It deliberately does not restate page copy, so editing a sentence cannot break a gate. Add an entry when you add a page.
See AUTHORING.md for where a page goes, what its frontmatter means, and the conventions the gates enforce.
Component maintainers contributing material about their own component should use contributing/submission-pack/ and write the page in their own repository.
Pushes to main build and deploy to GitHub Pages via .github/workflows/deploy.yml, after the gates pass. The repository's Settings → Pages → Source must be set to "GitHub Actions" — a one-time manual step, not part of this repository.
The site publishes at https://ohs-foundation.github.io/ohs-docs/. Paths published there are permanent: if a page moves, add an entry to the @docusaurus/plugin-client-redirects list in docusaurus.config.js in the same change.