These files comprise the WP-CLI handbook (make.wordpress.org/cli/handbook) and WP-CLI commands directory (developer.wordpress.org/cli/commands).
The documentation is located in GitHub to enable a pull request-based editing workflow. Long-form documentation (e.g. "Commands cookbook") can be edited directly. Internal API docs and command pages are generated dynamically from the WP-CLI codebase using the wp handbook
series of commands. wp handbook gen-all
will regenerate all of the handbook pages.
All documentation is imported automatically into WordPress.org in a two step process:
- WordPress reads
commands-manifest.json
orhandbook-manifest.json
to understand all pages that need to be created. - Each WordPress page has a
markdown_source
attribute specifying a Markdown file to be fetched, converted to HTML, and saved in the database.
For make.wordpress.org/cli, the import process is a WordPress plugin running a WP Cron job every 15 minutes. For developer.wordpress.org/cli, this is a class in the devhub theme running a WP Cron job every 12 hours.