Add wp-docs skill for WordPress documentation standards#30
Open
galatanovidiu wants to merge 6 commits intotrunkfrom
Open
Add wp-docs skill for WordPress documentation standards#30galatanovidiu wants to merge 6 commits intotrunkfrom
galatanovidiu wants to merge 6 commits intotrunkfrom
Conversation
Add new wp-docs skill for writing and reviewing WordPress documentation following WordPress.org standards. Includes main SKILL.md with write/review modes, PHPDoc standards reference, and markdown standards reference.
Add wordpress-patterns.md covering hook, REST API, capability, and migration guide documentation templates. Add two eval scenarios for review-phpdoc and write-guide modes.
Add routing entry for documentation-related intents (PHPDoc, write docs, review docs, documentation standards) to the router decision tree.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
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.
What
Add a new
wp-docsskill that helps WordPress developers write and review documentation following WordPress.org standards.New files:
skills/wp-docs/SKILL.md— Main skill with write/review modes (109 lines)skills/wp-docs/references/phpdoc-standards.md— WordPress PHP Documentation Standardsskills/wp-docs/references/markdown-standards.md— User-facing markdown documentation standardsskills/wp-docs/references/wordpress-patterns.md— WordPress-specific doc patterns (hooks, REST API, capabilities, migration guides)eval/scenarios/wp-docs-review-phpdoc.json— Eval scenario for PHPDoc review modeeval/scenarios/wp-docs-write-guide.json— Eval scenario for guide writing modeModified files:
docs/skill-set-v1.md— Addedwp-docsto the current skills listskills/wordpress-router/references/decision-tree.md— Added routing entry for documentation tasksWhy
There was no skill covering documentation standards. Developers working on WordPress plugins and themes need consistent guidance for:
@param,@return,@since, hook docs)The closest existing skill (
wp-phpstan) covers type annotations for static analysis, not documentation standards — the boundary between the two is clearly defined in the skill's Escalation section.Testing
Additionally tested by running the skill's review mode against a real WordPress plugin PHP file (
ToolRegistry.php). The skill correctly identified 18 FIX items (missing@sincetags, bare@returntags), 3 IMPROVE suggestions, and 9 passing categories.Cross-model code review performed with Claude + Codex CLI. All findings addressed in fix commits.