Repository navigation
Description
Parent epic: #768 — Documentation epic
Base branch: theme-elementary-v2. Cover its functionality and subsequent changes based on it. Verify against the latest relevant v2 implementation and record the tested commit in the documentation PR.
Problem and scope
A developer should be able to discover the skeleton's useful functionality without reading its implementation. Create docs/features.md as a concise catalogue of built-in infrastructure, supplied examples, and optional features.
Proposed structure
- At a glance: distinguish infrastructure, removable examples, and optional features.
- Built-in functionality: summarize verified facilities such as bootstrap/registration, asset loading/builds, template/component helpers, and checks.
- Supplied examples: media-text extension, settings page, shortcode, components, and patterns present in the supported revision.
- Optional features: HMR and Tailwind, including defaults and developer-visible effects.
- Use or change something: links to initialization, daily development, and extension examples.
Entry format
For each facility include only what helps a developer start:
- Purpose and a practical use.
- Source location and whether it is skeleton-owned or framework-provided.
- Default state and whether it can be removed or toggled.
- A small usage example or direct link to the maintained example.
- How to verify it works and where to read more.
Boundaries
Initialization owns toggle/removal commands; local development owns watch/build commands. This page links to both. Detailed helper signatures and class behavior belong in wp-framework.
Align existing Tailwind/HMR documentation with verified behavior, including generated files and dependency-install requirements. Record implementation defects separately.
Acceptance criteria
- The catalogue covers shipped infrastructure as well as examples and optional features.
- Developers can find a facility, locate its files, and try or adapt it.
- Defaults and removal/toggle limitations match the supported revision.
- Framework-provided functionality links directly to relevant framework documentation.
- No duplicated command reference or exhaustive class catalogue is introduced.
Activity