Guide

Publish existing docs

Connect an existing Markdown documentation tree to WordPress without allowing an unreviewed workflow run to publish Pages or open pull requests.

Prompt Coding agent Code Thinking
Use $docspress-install to inspect this repository, reuse its existing Markdown documentation, and prepare a safe draft synchronization to WordPress.
$docspress-install @repository docs/ .github/workflows/
Use this path when the repository already has usable Markdown documentation.

If the repository does not have a usable docs tree yet, begin with Create docs with AI instead.

Prerequisites

  • A GitHub repository containing or ready to receive docs/.
  • A WordPress.com site or a self-hosted WordPress site whose Pages endpoint accepts the supplied Bearer token.
  • Permission to add a repository workflow and the WP_ACCESS_TOKEN Actions secret.
  • The DocsPress Blocks plugin when documentation uses wp:docspress/* custom blocks.
  • The DocsPress theme when you want the bundled documentation reading experience.
  1. Install the agent skills and ask the agent to reuse the existing docs directory.
  2. Authenticate WordPress.
  3. Run the first synchronization manually with mode: reconcile, drafts, and dry-run enabled.
  4. Inspect the Action summary, expected Page hierarchy, and proposed Markdown files.
  5. Approve a real draft write and review any WordPress-to-GitHub pull request.
  6. Enable GitHub-to-WordPress, WordPress-to-GitHub, or combined continuous synchronization only after the manual lifecycle succeeds.
Neutral
Existing docs stay in control

The starting workflow is manual, dry-run only, and targets draft Pages. WordPress publication and GitHub pull requests remain separate approval decisions.

existing Markdown · dry-run · draft