Skip to content

docs: correct the example of usage the value parameter in badge#2853

Merged
alexdln merged 1 commit into
npmx-dev:mainfrom
btea:docs/fix-badge-value-parameters-usage
Jun 5, 2026
Merged

docs: correct the example of usage the value parameter in badge#2853
alexdln merged 1 commit into
npmx-dev:mainfrom
btea:docs/fix-badge-value-parameters-usage

Conversation

@btea
Copy link
Copy Markdown
Contributor

@btea btea commented Jun 5, 2026

🔗 Linked issue

/

🧭 Context

/

📚 Description

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Jun 5, 2026

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

Project Deployment Actions Updated (UTC)
docs.npmx.dev Ready Ready Preview, Comment Jun 5, 2026 1:23am
npmx.dev Ready Ready Preview, Comment Jun 5, 2026 1:23am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
npmx-lunaria Ignored Ignored Jun 5, 2026 1:23am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 5, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ae5c66e7-bb79-4d96-96eb-fffb7095bbd5

📥 Commits

Reviewing files that changed from the base of the PR and between 94edd11 and e274370.

📒 Files selected for processing (1)
  • docs/content/2.guide/6.badges.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Corrected query parameter documentation in the badges customisation guide to accurately reflect parameter usage and improve configuration guidance.

Walkthrough

The badges documentation was corrected to align the query parameter example with its intended semantics. The value customisation parameter section previously showed ?label=YOUR_LABEL but now correctly displays ?value=YOUR_VALUE.

Changes

Badge Documentation

Layer / File(s) Summary
Value parameter query example correction
docs/content/2.guide/6.badges.md
Query parameter example in the value customisation section updated from ?label=YOUR_LABEL to the correct ?value=YOUR_VALUE.
🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description contains only placeholder sections and does not provide any substantive information about the changes, context, or rationale for the documentation update. Provide a meaningful description explaining the documentation correction, why it was needed, and any relevant context about the badge parameter usage.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: correcting documentation for the value parameter example in a badge file, which aligns with the actual modification in docs/content/2.guide/6.badges.md.
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.

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

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

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 5, 2026

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!

@alexdln alexdln added this pull request to the merge queue Jun 5, 2026
Merged via the queue into npmx-dev:main with commit 743cd6c Jun 5, 2026
25 checks passed
@btea btea deleted the docs/fix-badge-value-parameters-usage branch June 5, 2026 09:10
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