docs: add clarity around naming and target audience#843
docs: add clarity around naming and target audience#843danielroe merged 11 commits intonpmx-dev:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
📝 WalkthroughWalkthroughThe pull request updates documentation in CONTRIBUTING.md and README.md. CONTRIBUTING.md replaces the previous goals with a concrete goal for npmx.dev, adds a Core values section (Speed, Simplicity, Community‑first), reorganises the Table of Contents, and adds a naming guideline requiring the project name to appear lowercase as "npmx" in the UI alongside existing code‑style/pre‑commit guidance. README.md changes the registry link text from "npmjs.com" to "npm" (same URL) and renames the "Compatibility" bullet to "URL Compatibility" while preserving the URL‑replacement behaviour. 🚥 Pre-merge checks | ❌ 1❌ Failed checks (1 inconclusive)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
graphieros
left a comment
There was a problem hiding this comment.
Clarity, elegance and style.
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)
28-33:⚠️ Potential issue | 🟡 MinorAdd the new "npmx name" subsection to the table of contents.
The new "npmx name" subsection (lines 153-156) is missing from the TOC. All other subsections under "Code style" are listed, so this should be included for consistency and discoverability.
📝 Proposed fix to add the missing TOC entry
- [Code style](`#code-style`) + - [npmx name](`#npmx-name`) - [TypeScript](`#typescript`) - [Server API patterns](`#server-api-patterns`)
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
153-156: Consider simplifying the phrasing for clarity.The guidance is clear, but the phrasing on line 155 could be slightly more natural.
✏️ Suggested phrasing improvement
### npmx name -When adding the name of the project to anywhere in the UI, use `npmx` in all lowercase letters. +When displaying the project name anywhere in the UI, use `npmx` in all lowercase letters.
No description provided.