Skip to content

docs: growth-audit critical fixes (SECURITY 1.x, badges, pronunciation)#64

Merged
DataDave-Dev merged 3 commits into
mainfrom
growth-critical
Jul 2, 2026
Merged

docs: growth-audit critical fixes (SECURITY 1.x, badges, pronunciation)#64
DataDave-Dev merged 3 commits into
mainfrom
growth-critical

Conversation

@DataDave-Dev

@DataDave-Dev DataDave-Dev commented Jul 2, 2026

Copy link
Copy Markdown
Owner

What & why

First batch of critical fixes from the growth audit (docs/auditoria-crecimiento.md, internal):

  • SECURITY.md still said "becwright is pre-1.0" and supported "latest 0.x" — stale since yesterday's 1.0.0. Now supports latest 1.x. Small file, but it's the trust file.
  • Badges: add license, npm downloads and Python-versions next to CI/npm/PyPI (instant-trust heuristics for repo visitors), EN + ES.
  • Pronunciation in the hero: "bec-wright, as in playwright" was buried at line ~590 in the FAQ; the name is a spelling hurdle for anyone who hears it before reading it. Now it's right under the title, EN + ES.

Done outside this PR (repo settings, no code): +8 topics (now 20/20), wiki disabled (was empty), repo description inverted to lead with the benefit instead of the BEC jargon.

Test plan

  • Docs-only; becwright's own hook passes on both commits.
  • Badge URLs verified against shields.io patterns already in use.

Summary by CodeRabbit

  • Documentation

    • Updated the README badge area with additional project status badges, including npm downloads, Python versions, and license information. The project tagline was also reformatted for consistency.
  • Security

    • Clarified supported release guidance in the security policy, stating that fixes are provided only for the latest 1.x release and older versions are no longer supported.

The policy still said becwright is pre-1.0 and supported 'latest 0.x' after
the 1.0.0 release. Supported version is now latest 1.x.
Add license, npm downloads and Python-versions badges next to CI/npm/PyPI,
and surface the bec-wright pronunciation in the hero instead of burying it
in the FAQ — the name is a spelling hurdle for anyone who hears it before
reading it. Both EN and ES.
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

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

Next review available in: 56 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5fc9d6b0-8931-4b6e-97ef-239352daa4ce

📥 Commits

Reviewing files that changed from the base of the PR and between e4ed8a2 and 3c1f7e7.

⛔ Files ignored due to path filters (1)
  • assets/becwright-demo-animated.svg is excluded by !**/*.svg
📒 Files selected for processing (2)
  • README.es.md
  • README.md
📝 Walkthrough

Walkthrough

Updated README.md and README.es.md badge rows to include npm downloads, Python versions, and license badges, with minor tagline formatting changes. Updated SECURITY.md to state that only the latest 1.x release is supported, replacing the previous 0.x-based support policy.

Changes

Documentation Updates

Layer / File(s) Summary
README badge updates
README.md, README.es.md
Added npm downloads, Python versions, and license badges to the header badge rows; adjusted tagline formatting in README.md.
Security policy revision
SECURITY.md
Changed supported-version policy from 0.x-based to stating only the latest 1.x release receives fixes, with older releases marked unsupported.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the main documentation fixes: SECURITY policy, badges, and pronunciation.
Description check ✅ Passed The description covers what, why, and testing, but it merges the template sections and uses "Test plan" instead of "Checklist".
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch growth-critical

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.

Replace the static demo SVG with an animated one (CSS keyframes inside the
SVG — renders in GitHub's img context, weighs a few KB, stays crisp at any
size, no GIF tooling needed): git commit is typed, two blocking rules fire
with their why and the offending line, the commit is blocked, and the npx
try-it line closes with a blinking cursor. The static SVG stays for contexts
that don't animate.
@DataDave-Dev DataDave-Dev merged commit 45fc727 into main Jul 2, 2026
5 checks passed
@DataDave-Dev DataDave-Dev deleted the growth-critical branch July 2, 2026 18:16
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.

1 participant