Guide

Review and publish generated docs

Verify the generated Markdown against the repository, then hand the accepted tree to the normal DocsPress publishing workflow.

Review the generated tree

Confirm:

  • Every page is nonempty and has a unique route and title.
  • Relative links and local images resolve from the file containing them.
  • Commands, options, exports, environment variables, defaults, and errors match source or tests.
  • Examples are runnable, or clearly marked when execution is not practical.
  • Every wp:docspress/* attribute object is valid JSON and uses supported attributes.
  • No placeholder, credential, private helper, or unsupported claim slipped into public documentation.
Prompt Coding agent Code Thinking
Review the generated docs against this repository. Check every public API, command, configuration name, example, relative link, and DocsPress block attribute. Return incorrect or unsupported claims first, then make only evidence-backed documentation fixes.
$generate-docs-from-source @repository docs/ src/ test/
Run a source-backed editorial review before publication.

Run repository checks

Use the project’s real scripts in proportion to the change. At minimum, validate links and block JSON, run the relevant tests or examples, and check the final diff.

Check the documentation diff bash
git diff --check
git status --short

Hand off to publication

Once the generated tree is accepted, continue through Publish existing docs. The generated Markdown is now the existing documentation tree for $docspress-install.

  1. Install or verify the agent skills.
  2. Authenticate WordPress.
  3. Run the first synchronization as a manual draft dry run.
Success
Generated docs are ready for a safe preview

The reviewed Markdown tree can now enter the same dry-run and draft lifecycle as any hand-authored documentation.

reviewed Markdown → draft WordPress Pages