Skip to content
Menu
OpenD Documentation
Version 0.1
Sign in

Preview this documentation

This site is itself an OpenD docs project, in the site/ folder of the repository. Preview it to see the platform at work.

About this task

The project uses most of what it documents: conditional keys, reusable chunks, product-gated sections, a build-time DITAVAL, two PDF publications, a brand theme and context-sensitive help keys. Read its sources next to the rendered pages.

  1. Build the packages: pnpm build.
    The CLI runs the compiled output in packages/cli/dist, so build again after you pull changes.
  2. Validate the project: pnpm opend validate site.
    The last line reads 0 error(s), 0 warning(s).
  3. Preview it: pnpm opend preview site.
  4. Switch Preview as between the readers in site/preview-contexts.yaml.

    The navigation changes with the reader. For example, self-hoster sees the self-hosting guides and no embedded-help section, while managed-customer sees the embedded-help section and no Docker or Railway runbooks.

Results

A test in packages/cli/test/site.test.ts builds this project, requires zero problems, and renders every page and both publications for every preview reader, so the docs cannot silently break.