Valkyrian Labs logo

Local Validation

Validate, manifest, and plan docs changes before pushing.

Local Validation

Local validation is the fastest feedback loop for docs authors and agents.

  1. 1

    Validate

    Run payload-markdown-docs validate --source main-docs.

  2. 2

    Inspect a manifest

    Run payload-markdown-docs manifest --source main-docs --pretty.

  3. 3

    Preview a plan

    Run payload-markdown-docs plan --source main-docs.

Validate

1pnpm exec payload-markdown-docs validate --source main-docs

Validation checks source paths, frontmatter, asset paths, hashes, file limits, docs set slug, and manifest shape.

Manifest

1pnpm exec payload-markdown-docs manifest --source main-docs --pretty

The manifest is JSON. Human docs are emitted as files; skills and optional custom static fallback files are emitted as assets. Skills are optional: a missing default ./skills directory is skipped, while an explicitly supplied missing --skills <path> is treated as a configuration error. The manifest includes content and SHA-256 hashes, but it does not include server-owned target collection or field names.

Plan

1pnpm exec payload-markdown-docs plan --source main-docs

Without --existing, local planning assumes an empty target and reports creates. Server-side dry-runs can plan against current Payload records.

See CLI reference.