Skip to content

Documentation / Reference

Maintaining documentation

Last updated

Use this checklist when shipping a new plugin version so public docs stay accurate.

On each release

  1. Publish a changelog entry for the version.
  2. Find doc articles affected by the release (new module, REST change, hook rename, requirements bump).
  3. Edit each affected doc in wp-admin (Docs post type).
  4. Update the article body to match the code/readme.
  5. Save the doc — Last updated on the page updates automatically from the modified date. Use that date to confirm the article is still current after a release.

Adding a new doc page

  1. Create a Doc entry with a clear slug under /docs/your-slug/.
  2. Assign a Doc section term. For a module, pick that module’s child term under Modules (not the parent Modules term). The hub links to /docs/section/{module-slug}/ archives.
  3. Set Order (menu order) within its section — lower numbers appear first. Keep the overview at 10; extra pages 20, 30, …

New module

  1. Add a child Doc section under Modules (same slug as the plugin module).
  2. Add the slug to the hub and sidebar include= lists on the Docs archive and Docs sidebar templates.
  3. Publish an overview plus settings/usage sub-pages in that term.

Not yet in the plugin UI

Cart Notices is registered but hidden (enabled: false). Checkout Field Manager, Store Vacation, Product Bundles, and Points & Rewards are roadmap only — add module docs when those modules ship.