What are guides for?
Guides are task-based playbooks. They are meant for decisions, release steps, troubleshooting, and operational safety. Use the technical docs when you need API details, command references, or integration internals.
Guides are task-based playbooks. They are meant for decisions, release steps, troubleshooting, and operational safety. Use the technical docs when you need API details, command references, or integration internals.
The fastest path is not alphabetical. Choose the situation below, then follow the linked guide chain.
Pick the situation you are in and jump straight to the right playbook.
| Risk | Typical guides | Rule of thumb |
|---|---|---|
| Low | First-time setup, demo data, audit trail, integration matrix | Safe to read or test locally; still avoid production demo data. |
| Medium | Git workflow, selective push, global styles, ACF fields, media remapping | Use dry runs and verify related data before remote sync. |
| High | Production imports, full automatic sync, broad overwrite, maintenance release windows | Require backups, approval, explicit conflict strategy, and rollback plan. |
| Trigger | Update needed | Owner action |
|---|---|---|
| CHANGELOG adds a feature | Add or update a guide if it changes user workflow | Check guides, docs, search results, and integration matrix. |
| CLI syntax changes | Update command examples and workflow-ID instructions | Run a content scan for old flags/examples. |
| REST/webhook behavior changes | Update technical docs and automation guides | Check auth, token, rate-limit, and method wording. |
| New integration manifest | Update integration matrix and related feature guides | Add dependencies, conflict notes, and CLI availability. |
| Production safety behavior changes | Update Production Release Checklist | Re-check backups, conflicts, approvals, maintenance, and rollback steps. |
When the in-plugin guides are removed later, keep contextual links from admin screens to these public guides: Workflows to workflow playbooks, Activity to troubleshooting, Config Remotes to connection fixes, and conflict queues to conflict resolution.