DenialOS
Docs / Documentation deployment
DEPLOYED
⏱️ 1 min read · 198 words

Documentation deployment

Canonical host

https://docs.denialos.io

How a page is published

  1. content is authored as Markdown with front matter in docs/public/;
  2. the page is rendered into docs-site/, which is the published static artifact;
  3. the source and the published page are committed together, so the served page is always the reviewed artifact.

Artifacts

Note on the renderer

scripts/build-public-docs.py renders the Markdown source into a dependency-light page shell. It does not reproduce the published page design (navigation, footer, previous/next links), so it must not be run over the published directory. Non-Markdown artifacts that no renderer emits live in the published directory and are committed as-is.

Deployment requirements

Serve the published directory from a static host/CDN that honors the included clean-route and security configuration.

Set PUBLIC_DOCS_BASE_URL when rendering for a host other than the default.

Do not expose docs/internal/ or repository secrets through the public static host.