docs: refresh AGENTS.md#257
Merged
Merged
Conversation
Rewrite AGENTS.md to fix stale claims, promote workflow rules, and restructure for findability. - Replace stale 'two bundles today' table with a pointer to package.json build:* scripts + vite.config.js (now ~17 targets). - Remove fictional 'since 0.15.0' / 'since 0.17.0' markers and the redundant 'since 0.5.5' tags (plugin is at 0.8.6; all are baseline). - Replace the 134-line ASCII Doc Tree with a 19-row table that matches the actual docs/ contents. The prior tree was missing about half of the docs and around 21 examples. - Switch typecheck guidance from ./node_modules/.bin/tsc --noEmit to npm run typecheck. - Drop the reference to docs/components-reference.md (does not exist). - Reorder into Hard rules -> Workflow -> Process reminders -> Contributor gotchas -> Developer docs map, so the highest-bite rules (assets/js/, trackedFetch, wpdConfirm, wpd-*) come first. - Add a Contents TOC. - Reframe the opening: drop the broken 'Short file' claim and describe the doc as the rulebook + cheatsheet for working inside the codebase, with docs/ as the public contract. - Promote four standing workflow rules from personal notes into the shared doc: npm run build after a batch, branch + PR (never trunk), bin/sync-to-wp-develop.sh over raw rsync, and no POT/PO/JSON regeneration in feature PRs.
Contributor
✅ WordPress Plugin Check Report
📊 ReportAll checks passed! No errors or warnings found. 🤖 Generated by WordPress Plugin Check Action • Learn more about Plugin Check |
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
1 participant
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
Refresh
AGENTS.mdto fix stale claims, surface workflow rules, and restructure for findability.Factual fixes
package.jsonbuild:*scripts +vite.config.js. The repo now has ~17 build targets, not two.docs/contents. The old tree was missing roughly half the top-level docs and ~21 example pages../node_modules/.bin/tsc --noEmittonpm run typecheck.docs/components-reference.md(does not exist; thestatic helpblock on each<wpd-*>class is the actual convention, verified across all 55 components).Promoted workflow rules
Moved four standing rules from personal notes into the shared doc:
npm run buildonce at the end of a batch (not between intermediate edits).bin/sync-to-wp-develop.shover rawrsync.Structure
assets/js/is build output,trackedFetch,wpdConfirm,wpd-*) come first.## ContentsTOC.docs/as the public contract for plugin authors.Net result: 327 lines → 327 lines (similar length), but with substantive content corrected and the high-frequency rules surfaced.
Test plan
AGENTS.mdand confirm the Doc map table matches your mental model ofdocs/.