Skip to content

Validate a docs project

Run the same checks as CI and the hosted build: broken links, missing chunks, undeclared values, bad release ranges and more.

opend validate builds the project in memory and reports every problem with its file, line and column. The previewer and the hosted worker run exactly the same checks, so a project that validates locally publishes.

  1. From the OpenD checkout, validate your docs folder.
    pnpm opend validate path/to/docs

    Each problem prints on its own line, followed by a summary:

    topics/install.dita:14:9: error [broken-link] link target not found: setup.dita
    topics/install.dita:20:7: warning [unresolved-key] key "edition" is not defined; using fallback content
    1 error(s), 1 warning(s)
  2. Fix each problem.

    The code in brackets identifies the problem. Validation diagnostics explains every code and how to fix it.

  3. Optional: validate a release branch or tag without checking it out.
    pnpm opend validate path/to/docs --ref v1

The command exits with status 1 when there is at least one error, and 0 otherwise. Warnings do not fail it unless you pass --strict.

To validate every pull request, see Validate every pull request. For every option, see CLI reference.