feat(docs): add links to advanced badges generator#2183
feat(docs): add links to advanced badges generator#2183ghostdevv merged 2 commits intonpmx-dev:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis 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
Suggested reviewers
🚥 Pre-merge checks | ✅ 1✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment Tip CodeRabbit can use OpenGrep to find security vulnerabilities and bugs across 17+ programming languages.OpenGrep is compatible with Semgrep configurations. Add an |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/content/2.guide/6.badges.md (1)
73-73: Prefer an explicit Markdown link instead of a bare URLAt 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
📒 Files selected for processing (1)
docs/content/2.guide/6.badges.md
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Co-authored-by: CodeRabbit <132028505+coderabbitai@users.noreply.github.com>
ghostdevv
left a comment
There was a problem hiding this comment.
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!
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.