Skip to content

docs(readme): tighten wp.org tagline and description wording - #153

Merged
jackgranatowski merged 3 commits into
mainfrom
claude/readme-wording-touchup
Jul 3, 2026
Merged

docs(readme): tighten wp.org tagline and description wording#153
jackgranatowski merged 3 commits into
mainfrom
claude/readme-wording-touchup

Conversation

@jackgranatowski

Copy link
Copy Markdown
Contributor

Summary

Splits the live-readme wording tweak out of #147, isolated from that PR's unrelated relicense and lucide-fix changes.

The tagline and the brand/status color paragraph in SLASHED-for-WP/readme.txt crammed multiple comma-separated lists into single run-on sentences (e.g. "with native Bricks Builder tooling: token pickers, a color browser, class hints, and BEM automation"). Shortened the tagline to one clear claim and split the listiest sentence into shorter ones with more natural rhythm.

Type

  • docs
  • fix
  • feat
  • chore / tooling

Notes

Deliberately excludes the License: GPL-2.0-or-laterGPL-3.0-or-later lines that were also present in #147's version of this file — that belongs to #149, which already owns the relicense scope. This PR only touches wording, not the license header.

Supersedes the wording portion of #147, which should be closed in favor of this PR and #149 (relicense) and #135 (already-merged lucide fix).


Generated by Claude Code

The tagline and the brand/status color paragraph crammed multiple
comma-separated lists into single run-on sentences. Shorten the tagline
to one clear claim and split the listiest sentence into shorter ones
with more natural rhythm.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@jackgranatowski, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 37 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 31dbbc1e-cc54-4639-9f42-5dbb78dd0207

📥 Commits

Reviewing files that changed from the base of the PR and between b9631c2 and c2fe8a4.

📒 Files selected for processing (1)
  • SLASHED-for-WP/readme.txt
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/readme-wording-touchup

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Docs: tighten wp.org readme tagline and description wording

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Shorten the wp.org readme tagline to a single, clearer product claim.
• Rewrite the brand/status color paragraph to reduce run-on, list-heavy phrasing.
• Keep scope strictly to wording (no license/header changes).
High-Level Assessment

The PR’s approach (tighten tagline + split list-heavy sentence into shorter statements) is the simplest, lowest-risk way to improve readability without changing meaning or scope.

Files changed (1) +2 / -2

Documentation (1) +2 / -2
readme.txtClarify tagline and simplify brand/status color copy +2/-2

Clarify tagline and simplify brand/status color copy

• Replaces the tagline’s feature-list sentence with a more direct positioning statement. Refactors the brand/status colors paragraph into shorter, clearer sentences while preserving the same claims and feature coverage.

SLASHED-for-WP/readme.txt

@qodo-code-review

qodo-code-review Bot commented Jul 3, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📜 Skill insights (0)

Context used
✅ Compliance rules (platform): 5 rules

Grey Divider


Remediation recommended

1. Brand dark values omitted ✓ Resolved 🐞 Bug ≡ Correctness
Description
The updated readme paragraph implies only the five status colors accept an optional separate dark
value, but the implementation supports separate dark overrides for both brand and status palettes.
This makes the public plugin description inaccurate for users configuring brand colors.
Code

SLASHED-for-WP/readme.txt[23]

+Set the six brand colors (primary, secondary, tertiary, action, neutral, base) and the framework recolors itself — hover and active states, tints, shades, and tonal steps are all computed for you. The five status colors (success, warning, error, info, danger) work the same way. Each one takes an optional separate dark value.
Relevance

⭐⭐⭐ High

Team prioritizes readme accuracy; PRs #84/#85 rewrote readme to remove stale/inaccurate claims and
sync with implementation.

PR-#84
PR-#85
PR-#77

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The readme text attaches the optional dark value only to status colors, while the token defaults and
inventory indicate brand colors also have distinct dark sources/overrides.

SLASHED-for-WP/readme.txt[21-23]
SLASHED-for-WP/includes/class-token-defaults.php[64-95]
SLASHED-for-WP/data/inventory.json[201-267]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The readme currently states that the five status colors take an optional separate dark value, but it no longer states the same for the six brand colors. The codebase supports `brand_dark` overrides too, so the docs should reflect that both groups can have optional dark values.

### Issue Context
This is a documentation accuracy regression introduced by the wording split in the Design Settings section.

### Fix Focus Areas
- SLASHED-for-WP/readme.txt[23-23]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

Comment thread SLASHED-for-WP/readme.txt Outdated
claude added 2 commits July 3, 2026 11:07
The wording split in the previous commit left "each one takes an
optional separate dark value" reading as scoped to status colors only.
Brand colors have the same brand_dark override support
(class-token-defaults.php), so the readme undersold that.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The framework has four status colors (success, warning, info, danger),
not five — --sf-color-error was removed and renamed to --sf-color-danger
(see SLASHED's docs/migration.md and token-registry.json). Aligns with
the correct count already used in the copy-wip readme draft.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016rBJXkhpA2ZvDxsoRWFZGG
@jackgranatowski
jackgranatowski merged commit f1f1831 into main Jul 3, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants