CoverKit documentation
Documentation in this folder is limited to facts verifiable in plugin source (includes/, src/, schemas/) or the plugin README on GitHub.
- Changelog — release notes (generated from root
CHANGELOG.md) - Roadmap — planned features (generated from
knowledge/roadmap/; aspirational, not shipped behavior)
Codebase reference
Section titled “Codebase reference”For developers extending or debugging CoverKit:
- Codebase index — boot order, data model, entry points
- Use cases and output profiles — canonical architecture for use cases
- PHP backend — core classes and field pipeline
- REST API —
coverkit/v1routes - Blocks and editor — Gutenberg blocks and
src/editor/use-cases/ - Native block bindings — WordPress 7.0
metadata.bindingson layers - Hooks and extension points — filters and actions
- PHP examples —
examples/admin page - Documentation maintenance — how to run
/update-docs - Image placeholders — tracked screenshot placeholders
User guide
Section titled “User guide”For site owners and editors:
- User guide index
- Installation
- Getting started
- Settings
- Templates
- Overview: templates list · list walkthrough
- Editor: overview · template editor · blocks
- Open Graph images
- Use cases: overview · configure · Open Graph · featured image · Sandbox
- Placeholders
- Caching: overview · clearing cache
- FAQ
- Troubleshooting