Refresh and expand the documentation set#155
Merged
Conversation
The README's changelog link pointed at the old `trunk` branch, which prompted a wider review of how documentation serves different audiences. Audience-specific guides under `docs/` (theme developers, hooks reference, REST API) replace the previous arrangement where the README tried to serve installers, theme developers, plugin extenders, and headless integrators in one short page. The README now sticks to what WordPress.org renders well — overview, installation, FAQ, upgrade notice, screenshots — and links out to the deeper material. `SECURITY.md` and `CONTRIBUTING.md` fill the gaps that were notable after the 0.11.0 security release: researchers had no signposted disclosure route, and new contributors had to reverse-engineer the process from `AGENTS.md`. `AGENTS.md` had drifted (still claimed version 0.8.0, missed several composer scripts, didn't mention the vendored Mixtape REST framework), and `tests/README.md` documented composer commands that don't exist. Both are now accurate. `.distignore` excludes the GitHub-only files so the WordPress.org build stays lean; the README links to the docs at absolute GitHub URLs so they resolve from both surfaces.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Started as a one-line fix — the README's changelog link still pointed at
trunk— and grew into a wider review of how the documentation serves the audiences who interact with this plugin. Three were notably underserved: theme developers wanting more than four template-tag signatures, plugin authors looking for hooks that aren'tzoninator_zone_lock_period, and headless integrators wondering how the REST API behaves now thatGET /zonesrequires authentication.The README previously tried to address all of those audiences in one short page and didn't really succeed for any of them. It now sticks to what WordPress.org renders well — overview, installation, FAQ, upgrade notice, screenshots — and links out to a new
docs/folder for deeper material. The audience-specific guides (theme developers, hooks reference, REST API) live there, with the hooks reference covering all ~50 plugin hooks and the REST guide documenting every route underzoninator/v1, including thezoninator_rest_get_zones_permissions_checkescape hatch introduced in 0.11.0.SECURITY.mdandCONTRIBUTING.mdfill gaps that became conspicuous after the 0.11.0 security release. Researchers had no signposted disclosure route —SECURITY.mdnow points at HackerOne, mirroring Edit Flow's pattern. New contributors had to reverse-engineer process fromAGENTS.md(which is written for LLMs) —CONTRIBUTING.mdnow covers bug-report expectations, localwp-envsetup, and the public-API contract.While auditing, two existing files turned out to be wrong:
AGENTS.mdstill claimed version 0.8.0 and missed several composer scripts and the vendored Mixtape REST framework, andtests/README.mddocumentedcomposer prepare-ciandcomposer testcommands that don't exist. Both are now accurate..distignoreexcludes the new GitHub-only docs (docs/,CONTRIBUTING.md,SECURITY.md) so the WordPress.org SVN package stays lean. The README links to those docs at absolute GitHub URLs so they resolve from both the GitHub repository view and the WordPress.org listing.Test plan
docs/files end-to-end and sanity-check the hook signatures and REST descriptions against the source..distignoreadditions exclude the right files (next deploy will be the real test).