Skip to content

feat(docs): add links to advanced badges generator#2183

Merged
ghostdevv merged 2 commits intonpmx-dev:mainfrom
trueberryless:docs/link-badges-generator
Mar 21, 2026
Merged

feat(docs): add links to advanced badges generator#2183
ghostdevv merged 2 commits intonpmx-dev:mainfrom
trueberryless:docs/link-badges-generator

Conversation

@trueberryless
Copy link
Contributor

Description

As quickly mentioned in this comment, we could link to the advanced badges generator (https://npmx-badge.vercel.app/) from our docs to inform more people about it and make it accessible faster.

@vercel
Copy link

vercel bot commented Mar 21, 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 Mar 21, 2026 8:09pm
npmx.dev Ready Ready Preview, Comment Mar 21, 2026 8:09pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
npmx-lunaria Ignored Ignored Mar 21, 2026 8:09pm

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 21, 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: 9e7e1ede-a44c-480d-b989-ea5feebd28ed

📥 Commits

Reviewing files that changed from the base of the PR and between 8faffec and dbb02d2.

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

📝 Walkthrough

Walkthrough

This PR adds a tip callout to docs/content/2.guide/6.badges.md under the "Customization Parameters" section linking to an external badges generator at https://npmx-badge.vercel.app/. No other content, parameters, examples or exported entities were changed. Changes: +4/−0 lines.

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • danielroe
  • ghostdevv
🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The pull request description clearly relates to the changeset, explaining the addition of links to an external badges generator in the 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

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.

Tip

CodeRabbit can use OpenGrep to find security vulnerabilities and bugs across 17+ programming languages.

OpenGrep is compatible with Semgrep configurations. Add an opengrep.yml or semgrep.yml configuration file to your project to enable OpenGrep analysis.

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.

🧹 Nitpick comments (1)
docs/content/2.guide/6.badges.md (1)

73-73: Prefer an explicit Markdown link instead of a bare URL

At Line 73, the bare URL ends with sentence punctuation; some renderers/copy flows can handle this awkwardly. Consider an explicit link for clarity and consistency.

Suggested edit
-For a more advanced badges generator, check out https://npmx-badge.vercel.app/.
+For a more advanced badges generator, check out [npmx-badge.vercel.app](https://npmx-badge.vercel.app/).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: bfdad52b-c074-4ddd-acb0-ae47bca207d7

📥 Commits

Reviewing files that changed from the base of the PR and between d86c9c4 and 8faffec.

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

@codecov
Copy link

codecov bot commented Mar 21, 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!

Co-authored-by: CodeRabbit <132028505+coderabbitai@users.noreply.github.com>
Copy link
Contributor

@ghostdevv ghostdevv left a comment

Choose a reason for hiding this comment

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

LGTM! We also link to it on the README #2093. We can always remove this link if we decide to add more features to the one on the docs - I forgot to say to @yuyinws in that PR that we could bring this feature into npmx itself (via docs), so glad to see you've been working on it @trueberryless!

@ghostdevv ghostdevv added this pull request to the merge queue Mar 21, 2026
Merged via the queue into npmx-dev:main with commit fbe0b26 Mar 21, 2026
20 checks passed
@trueberryless trueberryless deleted the docs/link-badges-generator branch March 21, 2026 22:41
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