-
-
Notifications
You must be signed in to change notification settings - Fork 244
docs: npm comparison/features #1409
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
📝 WalkthroughWalkthroughThis pull request updates documentation to provide more comprehensive feature coverage and detailed comparisons. The README.md file expands the comparison table with npmjs.com to include granular categorisation of features across package browsing, admin capabilities, and npmx.dev-specific functionality. The features documentation (docs/content/2.guide/1.features.md) is reorganised and significantly expanded with new feature categories, detailed descriptions of package viewing capabilities, security and provenance features, user administration functions, social features, and an extensive keyboard shortcuts reference. The changes restructure existing information into a more detailed and categorised format. 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)
Comment |
There was a problem hiding this 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)
docs/content/2.guide/1.features.md (1)
254-266:⚠️ Potential issue | 🟡 MinorAlign badge colour parameter naming.
You describe
colorbut the examples usecolorB, which will confuse readers and lead to broken badges. Please standardise on one parameter name (and update examples accordingly).🔧 Example alignment (if `color` is correct)
-| **Hot Pink** | `.../badge/version/nuxt?colorB=ff69b4` | -| **Pure Black** | `.../badge/version/nuxt?colorB=000000` | -| **Brand Blue** | `.../badge/version/nuxt?colorB=3b82f6` | +| **Hot Pink** | `.../badge/version/nuxt?color=ff69b4` | +| **Pure Black** | `.../badge/version/nuxt?color=000000` | +| **Brand Blue** | `.../badge/version/nuxt?color=3b82f6` |
| | :icon{name="i-simple-icons-github"} [GitHub](https://github.com) | The most popular git hosting platform | | ||
| | :icon{name="i-simple-icons-gitlab"} [GitLab](https://gitlab.com) | Self-hosted instances supported | | ||
| | :icon{name="i-simple-icons-bitbucket"} [Bitbucket](https://bitbucket.org) | Atlassian's git hosting service | | ||
| | :icon{name="i-simple-icons-codeberg"} [Codeberg](https://codeberg.org) | Free hosting for open source projects | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hyphenate compound adjective.
“open source projects” should be “open‑source projects” when used as a compound adjective.
✏️ Proposed tweak
-| :icon{name="i-simple-icons-codeberg"} [Codeberg](https://codeberg.org) | Free hosting for open source projects |
+| :icon{name="i-simple-icons-codeberg"} [Codeberg](https://codeberg.org) | Free hosting for open‑source projects |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | :icon{name="i-simple-icons-codeberg"} [Codeberg](https://codeberg.org) | Free hosting for open source projects | | |
| | :icon{name="i-simple-icons-codeberg"} [Codeberg](https://codeberg.org) | Free hosting for open-source projects | |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~156-~156: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s://codeberg.org) | Free hosting for open source projects | | :icon{name="i-simple-icons...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
|
What about rendering this on an actual web page on the front end? 🤓 |
this might be too verbose e.g. for the readme, but this is almost more for my own brain to keep track of things.
wdyt?