docs: draft plugin README, wp.org readme.txt, and community post - #150
Conversation
Parks three copy drafts in copy-wip/ for review before promotion: - github-readme.md — repo README rewrite (leads with Design Settings / Bricks / Gutenberg, corrects the status-color and bundle claims, documents the vendored admin-app/src warning), with a 'name is the philosophy' section woven in and leading with Agnostic as the reason the plugin exists. - wordpress-org-readme.txt — corrected wp.org description (four status colors not five, honest bundle-equivalence note) plus the same philosophy framing. - facebook-post-bricks-community.md — draft post for the Bricks community group. Split out of #137, which bundled these drafts together with an unrelated GPL relicense and an admin-app build fix (the latter has since landed on main independently, so it needs no separate PR). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019y4H17xqMWoEgvxv3BRM98
|
Warning Review limit reached
Next review available in: 47 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
PR Summary by QodoDocs: add draft README, wp.org readme, and Bricks community post
AI Description
Diagram
High-Level Assessment
Files changed (3)
|
Code Review by Qodo
Context used✅ Compliance rules (platform):
5 rules 1. Draft metadata stale
|
| Stable tag: 0.4.20 | ||
| Requires PHP: 7.4 | ||
| License: GPL-3.0-or-later | ||
| License URI: https://www.gnu.org/licenses/gpl-3.0.html |
There was a problem hiding this comment.
1. Draft metadata stale 🐞 Bug ≡ Correctness
copy-wip/wordpress-org-readme.txt declares Stable tag 0.4.20 and GPL-3.0-or-later, but the plugin headers and current SLASHED-for-WP/readme.txt are 0.4.21 and GPL-2.0-or-later. If this draft is promoted to wp.org readme.txt as-is, it will publish incorrect version/license metadata.
Agent Prompt
### Issue description
`copy-wip/wordpress-org-readme.txt` has a stale `Stable tag` and incorrect license fields (GPLv3), which conflict with the plugin’s declared version/license.
### Issue Context
- The plugin version is declared in `SLASHED-for-WP/slashed.php` and should match wp.org `Stable tag`.
- The plugin license is declared as GPL-2.0-or-later in both the plugin header and `SLASHED-for-WP/readme.txt`.
### Fix Focus Areas
- copy-wip/wordpress-org-readme.txt[6-9]
- SLASHED-for-WP/slashed.php[3-12]
- SLASHED-for-WP/readme.txt[5-9]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
There was a problem hiding this comment.
Split into two parts:
- Stable tag / changelog were genuinely stale (0.4.20 vs the plugin's actual 0.4.21) — real drift, not intentional. Fixed in
a8831a0: bumpedStable tagto0.4.21and added the missing0.4.21changelog entry (copied verbatim fromSLASHED-for-WP/readme.txtonmain). - The GPL-3.0-or-later license fields are intentionally forward-looking — this draft assumes
#149(the GPL-3 relicense PR) has landed first. Until then main is still GPL-2.0-or-later, and this copy PR is staged incopy-wip/specifically so it isn't promoted before that's true. No change needed there.
Generated by Claude Code
Stable tag and changelog were stale at 0.4.20; corrected to match the plugin's real current version so the draft doesn't publish wrong metadata if promoted as-is.
The copy-wip/wordpress-org-readme.txt draft merged via #150 had no == Screenshots == section. Add one covering the configurator (Design Settings, frontend overlay, standalone app) and the Bricks-specific features called out for the listing: the Color System panel, reBEMer, and class/variable hints. The actual screenshot-N.png assets still need to be captured from a live WordPress + Bricks install and are not included here. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Summary
Parks three copy drafts in
copy-wip/for review before promotion:github-readme.md— repo README rewrite. Leads with what the plugin does (Design Settings, Bricks, Gutenberg) before build internals, keeps the vendored-admin-app/srcwarning prominent, and corrects factual claims from the live README. Adds a "name is the philosophy" section leading with Agnostic as the reason the plugin exists — the framework locks you into nothing, the plugin is just the WordPress-native wiring.wordpress-org-readme.txt— corrected wp.org description: four status colors (success/warning/danger/info), not five ("error" doesn't exist), and an honest note that the Components/Utilities/Full bundles currently style identically to Optimal because those framework layers are staged upstream. Same philosophy framing woven in.facebook-post-bricks-community.md— draft post for the Bricks Builder community group: leads with the "why another framework" question, names the acronym/philosophy, is upfront about the beta status and browser floor.Context
Split out of #137, which bundled these drafts together with an unrelated GPL relicense (#[relicense PR]) and an admin-app build fix (already landed on
mainindependently, needs no separate PR).Test plan
github-readme.md→README.mdandwordpress-org-readme.txt→SLASHED-for-WP/readme.txt's description section; post the FB draft manually🤖 Generated with Claude Code
Generated by Claude Code