Skip to content

docs: fix broken badge note block by rewording contents - #2925

Merged
ghostdevv merged 5 commits into
npmx-dev:mainfrom
btea:docs/badge-page-format-note-info
Jul 5, 2026
Merged

docs: fix broken badge note block by rewording contents#2925
ghostdevv merged 5 commits into
npmx-dev:mainfrom
btea:docs/badge-page-format-note-info

Conversation

@btea

@bteabtea commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

🔗 Linked issue

🧭 Context

Before:After:
imageimage

📚 Description

rel #2922

@vercel

vercelBot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
docs.npmx.devReadyReadyPreview, CommentJun 19, 2026 12:28am
npmx.devReadyReadyPreview, CommentJun 19, 2026 12:28am
1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
npmx-lunariaIgnoredIgnoredJun 19, 2026 12:28am

Request Review

@coderabbitai

coderabbitaiBot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Two badge guide callouts in docs/content/2.guide/6.badges.md change from ::note to ::tip, and both examples are shortened by removing the explicit Wrong/Correct lines. The color section also now references ?labelColor=#000000`` in its explanatory text.

Changes

Badges documentation callout update

Layer / File(s)Summary
Update note callouts to tip in labelColor and color sections
docs/content/2.guide/6.badges.md
The ::note callouts are replaced with ::tip in both the labelColor and color URL-encoding guidance blocks, and the example text is shortened; the color block now references ?labelColor=#000000`` in its explanation.

Possibly related PRs

  • npmx-dev/npmx.dev#2922: Modifies the same labelColor and color documentation sections and the surrounding #/URL fragment guidance.

Suggested reviewers:ghostdevv

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check nameStatusExplanation
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Title check✅ PassedThe title matches the documentation change by describing the badge note block rewording and fix.
Description check✅ PassedThe description is related to the docs change and includes context for the before/after badge rendering.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@codecov

codecovBot commented Jun 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@btea

btea commented Jun 19, 2026

Copy link
Copy Markdown
ContributorAuthor

It appears to be caused by vp fmt.

@btea

btea commented Jun 22, 2026

Copy link
Copy Markdown
ContributorAuthor

It seems there's no way to remove the space before the :: tag at the end of newly added tip groups; automatic formatting adds it by default, causing rendering errors. Is there any way to solve this? @ghostdevv

@ghostdevv

Copy link
Copy Markdown
Member

It seems there's no way to remove the space before the :: tag at the end of newly added tip groups; automatic formatting adds it by default, causing rendering errors. Is there any way to solve this? @ghostdevv

when we manage to get the next vite-plus update merged, we can see if it fixes it 🙏

@ghostdevv

Copy link
Copy Markdown
Member

Looks like that didn't fix it, I assume it doesn't like the list inside so I just reworded the section 🙏

@ghostdevvghostdevv changed the title docs: format badge page note infodocs: fix broken badge note block by rewording contentsJul 5, 2026
@ghostdevv
ghostdevv enabled auto-merge July 5, 2026 19:17
@ghostdevv
ghostdevv added this pull request to the merge queueJul 5, 2026
Merged via the queue into npmx-dev:main with commit 39a6b8cJul 5, 2026
25 checks passed
@github-actionsgithub-actionsBot mentioned this pull request Jul 5, 2026
@btea
btea deleted the docs/badge-page-format-note-info branch July 6, 2026 00:33
ayo-run pushed a commit to ayo-run/npmx.dev that referenced this pull request Aug 5, 2026
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Willow (GHOST) <git@willow.sh>
Sign up for freeto 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

@btea@ghostdevv