Skip to content

docs: fix note rendering#3987

Merged
dyc3 merged 3 commits intobiomejs:mainfrom
j0k3r:patch-1
Feb 21, 2026
Merged

docs: fix note rendering#3987
dyc3 merged 3 commits intobiomejs:mainfrom
j0k3r:patch-1

Conversation

@j0k3r
Copy link
Contributor

@j0k3r j0k3r commented Feb 20, 2026

Fix note rendering for Playwright, Turbo & Types

Summary

Before:
image

After:
image

Fix note rendering for Playwright
@netlify
Copy link

netlify bot commented Feb 20, 2026

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit cf0b5ac
🔍 Latest deploy log https://app.netlify.com/projects/biomejs/deploys/69988ed422f0870008803663
😎 Deploy Preview https://deploy-preview-3987--biomejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 20, 2026

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en src/content/docs/linter/domains.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 20, 2026

Warning

Rate limit exceeded

@j0k3r has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 3 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Walkthrough

The pull request modifies src/content/docs/linter/domains.mdx by replacing two admonition blocks with plain text formatting in the Next and Playwright activation sections. Specifically, the :::note[No recommended rules] admonition markers are converted to standard text paragraphs with closing :: markers, affecting only the visual presentation without altering any underlying configuration content or examples.

Possibly related PRs

Suggested labels

A-Documentation

Suggested reviewers

  • dyc3
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarises the main change: fixing note rendering in documentation markup, which directly corresponds to the changeset's replacement of note admonitions with plain text.
Description check ✅ Passed The description is directly related to the changeset, providing visual before/after examples of the note rendering fix for Playwright configuration documentation.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link
Contributor

@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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/content/docs/linter/domains.mdx (1)

393-394: ⚠️ Potential issue | 🟡 Minor

Same broken admonition syntax in Turborepo and Types domains — still not fixed.

The Turborepo (line 394) and Types (line 437) sections have the same malformed pattern this PR corrects for Playwright: the content, closing :::, and a stray # character are all concatenated on one line (...rules.:::#). Aside blocks are indicated using a pair of triple colons ::: to wrap content, so the closing marker must be on its own line; anything appended to it (like #) will break the block and produce garbled output.

Since all three occurrences almost certainly share the same codegen defect, fixing the generator (see previous comment) should resolve all of them in one go.

Also applies to: 436-437

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/content/docs/linter/domains.mdx` around lines 393 - 394, The admonition
blocks use a malformed closing marker (e.g., the opening ':::note[No recommended
rules]' block currently ends with ':::#' on the same line as the content), which
breaks the renderer; update the content for the Playwright, Turborepo and Types
admonitions so the closing marker is on its own line (':::') and remove the
stray '#' character, and if this is generated code, fix the generator that emits
the admonition so it inserts a newline before the closing ':::' (identify the
blocks by their opening token ':::note[No recommended rules]' and the
problematic closing ':::#' to locate and correct them).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/content/docs/linter/domains.mdx`:
- Around line 70-72: The autogenerated domains.mdx is produced by the codegen
invoked by pnpm codegen:rules and the bug is that the generator emits a
single-line aside block instead of a proper Starlight aside with separate
opening, body, and closing lines; find the codegen function/template (e.g.,
generateDomainDoc, renderDomainSection, or emitAside/renderAside) that writes
the string ":::note[No recommended rules]" and change it to output three
separate lines: the opening ":::note[No recommended rules]" line, the content
line(s) (e.g., "Since all rules..."), and a closing ":::". Ensure the
template/renderer uses newline-terminated writes or joins lines with "\n" so the
closing ":::"
is on its own line when domains.mdx is generated.

---

Outside diff comments:
In `@src/content/docs/linter/domains.mdx`:
- Around line 393-394: The admonition blocks use a malformed closing marker
(e.g., the opening ':::note[No recommended rules]' block currently ends with
':::#' on the same line as the content), which breaks the renderer; update the
content for the Playwright, Turborepo and Types admonitions so the closing
marker is on its own line (':::') and remove the stray '#' character, and if
this is generated code, fix the generator that emits the admonition so it
inserts a newline before the closing ':::' (identify the blocks by their opening
token ':::note[No recommended rules]' and the problematic closing ':::#' to
locate and correct them).

@dyc3 dyc3 merged commit 78d62ba into biomejs:main Feb 21, 2026
9 checks passed
@j0k3r j0k3r deleted the patch-1 branch February 26, 2026 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants