Skip to content

docs: add clarity around naming and target audience#843

Merged
danielroe merged 11 commits intonpmx-dev:mainfrom
whitep4nth3r:name-clarity
Feb 3, 2026
Merged

docs: add clarity around naming and target audience#843
danielroe merged 11 commits intonpmx-dev:mainfrom
whitep4nth3r:name-clarity

Conversation

@whitep4nth3r
Copy link
Collaborator

No description provided.

@vercel
Copy link

vercel bot commented Feb 3, 2026

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

Project Deployment Actions Updated (UTC)
npmx.dev Ready Ready Preview, Comment Feb 3, 2026 6:20pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
docs.npmx.dev Ignored Ignored Preview Feb 3, 2026 6:20pm
npmx-lunaria Ignored Ignored Feb 3, 2026 6:20pm

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 3, 2026

📝 Walkthrough

Walkthrough

The 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)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The pull request has no description provided by the author, making it impossible to verify that the changeset intent is adequately communicated. Add a pull request description that explains the naming clarity improvements, the rationale for changes to CONTRIBUTING.md and README.md, and how these changes benefit the project.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

Actionable comments posted: 1

@codecov
Copy link

codecov bot commented Feb 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Contributor

@graphieros graphieros left a comment

Choose a reason for hiding this comment

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

Clarity, elegance and style.

Copy link
Collaborator

@serhalp serhalp left a comment

Choose a reason for hiding this comment

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

LGTM

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.

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 | 🟡 Minor

Add 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.

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.

Actionable comments posted: 1

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.

Actionable comments posted: 1

@whitep4nth3r whitep4nth3r disabled auto-merge February 3, 2026 14:38
@whitep4nth3r whitep4nth3r changed the title fix: clarity around naming fix: clarity around naming and target audience Feb 3, 2026
Copy link
Collaborator

@serhalp serhalp left a comment

Choose a reason for hiding this comment

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

💯

@danielroe danielroe changed the title fix: clarity around naming and target audience docs: add clarity around naming and target audience Feb 3, 2026
@danielroe danielroe added this pull request to the merge queue Feb 3, 2026
Merged via the queue into npmx-dev:main with commit f8228f1 Feb 3, 2026
15 checks passed
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.

4 participants