Skip to content

docs: fix wording in the perimeters documentation#1032

Merged
tbouffard merged 5 commits intomainfrom
ai-findings-autofix/packages-website-docs-usage-perimeters.md
Mar 30, 2026
Merged

docs: fix wording in the perimeters documentation#1032
tbouffard merged 5 commits intomainfrom
ai-findings-autofix/packages-website-docs-usage-perimeters.md

Conversation

@tbouffard
Copy link
Copy Markdown
Member

@tbouffard tbouffard commented Mar 30, 2026

Also update the "edge styles" page for consistency.

Notes

This PR applies 2/2 suggestions from code quality AI findings.

Summary by CodeRabbit

  • Documentation
    • Standardized terminology: replaced references to "edge styles" with "perimeters" for consistency.
    • Clarified wording in informational callouts and conditional instructions (e.g., updated phrasing about prior removal and registration intent).

tbouffard and others added 2 commits March 30, 2026 06:49
… Copilot Autofix

Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
… Copilot Autofix

Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
@tbouffard tbouffard added the documentation Improvements or additions to documentation label Mar 30, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4188b2f0-65e0-465c-a509-4bc14c4edad5

📥 Commits

Reviewing files that changed from the base of the PR and between 58668b7 and f89aace.

📒 Files selected for processing (2)
  • packages/website/docs/usage/edge-styles.md
  • packages/website/docs/usage/perimeters.md
✅ Files skipped from review due to trivial changes (1)
  • packages/website/docs/usage/edge-styles.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/website/docs/usage/perimeters.md

Walkthrough

Updated documentation to replace "edge styles" with "perimeters" in PerimeterRegistry-related content and migration notes; adjusted a conditional phrasing from "if you are intended to use it" to "if you intend to use it"; a minor phrasing change in the EdgeStyleRegistry callout from "has then been removed" to "has since been removed."

Changes

Cohort / File(s) Summary
Perimeters doc
packages/website/docs/usage/perimeters.md
Terminology consistency: replaced "edge styles" with "perimeters" in PerimeterRegistry introduction and migration notes; corrected conditional phrasing to "if you intend to use it."
Edge styles callout
packages/website/docs/usage/edge-styles.md
Minor wording change in informational callout: "has then been removed" → "has since been removed."

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description lacks key required sections from the template including PR checklist completion, overview details, issue reference, and breaking change information. Complete the PR checklist, add an overview section explaining the changes and their context, and include an issue reference (e.g., 'closes #xxxx') to link the PR to a related issue.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change—fixing wording in the perimeters documentation—and matches the primary file modified.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

Co-authored-by: Thomas Bouffard <[email protected]>
@tbouffard tbouffard changed the title Potential fixes for 2 code quality findings docs: fix wording in the perimeters documentation Mar 30, 2026
@tbouffard tbouffard marked this pull request as ready for review March 30, 2026 10:18
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4f24c993-ec63-4c2d-ace1-25a7306cb289

📥 Commits

Reviewing files that changed from the base of the PR and between c769d39 and 58668b7.

📒 Files selected for processing (1)
  • packages/website/docs/usage/perimeters.md

tbouffard and others added 2 commits March 30, 2026 13:51
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@sonarqubecloud
Copy link
Copy Markdown

@tbouffard tbouffard merged commit c206f7e into main Mar 30, 2026
8 checks passed
@tbouffard tbouffard deleted the ai-findings-autofix/packages-website-docs-usage-perimeters.md branch March 30, 2026 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant