docs: add missing changelog and timeline routes by BittuBarnwal7479 · Pull Request #2906 · npmx-dev/npmx.dev · GitHub

🔗 Linked issue

🧭 Context

📚 Description

Adds the missing route entries for package changelog and timeline pages to the route reference table in CONTRIBUTING.md.

Added /package-changelog/:path+
Added /package-timeline/:path+

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

Project	Deployment	Actions	Updated (UTC)
npmx.dev	Ready	Preview, Comment	Jun 13, 2026 8:20pm

2 Skipped Deployments

Project	Deployment	Actions	Updated (UTC)
docs.npmx.dev	Ignored	Preview	Jun 13, 2026 8:20pm
npmx-lunaria	Ignored		Jun 13, 2026 8:20pm

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info ⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 67c8d8b4-bf63-4312-afbf-644d7c0d4437

📥 Commits

Reviewing files that changed from the base of the PR and between 1c48d0c and a737ac7.

📒 Files selected for processing (1)

CONTRIBUTING.md

📝 Walkthrough

Summary by CodeRabbit

Documentation
- Updated contributor guide to add new named routes: "changelog" and "changelog-version" for package changelog navigation.
- Added documentation for a new "timeline" named route for package timeline views.
- Included route parameter details for the newly documented routes.

Walkthrough

Adds three named route entries to CONTRIBUTING.md's "Available route names" table: changelog, changelog-version, and timeline, with their URL patterns and parameter descriptions.

Changes

Route Names Documentation

Layer / File(s)	Summary
Route names table entries CONTRIBUTING.md	Adds changelog → /package-changelog/:org?/:name, changelog-version → /package-changelog/:org?/:name/v/:version, and timeline → /package-timeline/:org?/:packageName/v/:version rows to the "Available route names" reference table, including parameter descriptions.

Possibly related issues

Missing package-changelog and package-timeline routes in CONTRIBUTING.md #2905: Adds the missing /package-changelog and /package-timeline route entries referenced by the issue.

Possibly related PRs

npmx-dev/npmx.dev#2866: Related documentation updates for timeline and changelog shortcuts.

Suggested reviewers

ghostdevv

🚥 Pre-merge checks | ✅ 4 ✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding missing changelog and timeline routes to the documentation.
Description check	✅ Passed	The description is related to the changeset, explaining that missing route entries were added to CONTRIBUTING.md for changelog and timeline pages.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✏️ 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.

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!

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 450-451: The table entries for the new routes are incorrect and
incomplete: replace the two lines with explicit-parameter entries and add the
missing changelog-version route; specifically, change the changelog entry to use
explicit params matching the route helper (name "changelog" with path pattern
"/package-changelog/:org?/:name" and params [org, name]), add a second entry
"changelog-version" with path "/package-changelog/:org?/:name/v/:version" and
params [org, name, version], and update the timeline entry to use the explicit
pattern "/package-timeline/:org?/:packageName/v/:version" with params [org,
packageName, version] so the table mirrors the actual route signatures (see
changelogRoute() and the package-timeline path).

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info ⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6934e5cb-dcc9-4720-9bbb-a3df6287fa5a

📥 Commits

Reviewing files that changed from the base of the PR and between 1c48d0c and 0dd8196.

📒 Files selected for processing (1)

CONTRIBUTING.md

Please you resolve this comment?

@CodeRabbit review.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the PR diff
gh pr view 2906 --repo npmx-dev/npmx.dev --json files,body,title

# Get the specific review comment
gh api repos/npmx-dev/npmx.dev/pulls/comments/3408421437

Length of output: 7445

@BittuBarnwal7479 The changes in the current commit look correct — my earlier concern (discussion_r3408421437) was already addressed in commit a737ac7. The route table now properly documents:

Route name	Pattern	Params
changelog	/package-changelog/:org?/:name	org?, name
changelog-version	/package-changelog/:org?/:name/v/:version	org?, name, version
timeline	/package-timeline/:org?/:packageName/v/:version	org?, packageName, version

This matches the actual route implementations, so the documentation is accurate now.

Regarding @trueberryless's request — they are asking you to resolve the conversation thread on GitHub. You can do that by clicking the "Resolve conversation" button on that comment in the Files Changed tab.

I'll trigger a full review now.

✅ Action performed

Full review finished.

Thanks!

Co-authored-by: Your Name <your@email.com>

docs: add missing changelog and timeline routes

0dd8196

vercel Bot deployed to Preview – npmx.dev June 13, 2026 18:42 View deployment

coderabbitai Bot reviewed Jun 13, 2026

View reviewed changes

Comment thread CONTRIBUTING.md Outdated

docs: correct changelog and timeline route definitions

a737ac7

vercel Bot deployed to Preview – npmx.dev June 13, 2026 20:20 View deployment

serhalp approved these changes Jun 14, 2026

View reviewed changes

serhalp added this pull request to the merge queue Jun 14, 2026

Merged via the queue into npmx-dev:main with commit ab3313a Jun 14, 2026
24 checks passed

github-actions Bot mentioned this pull request Jun 14, 2026

chore: release v0.16.0 #2856

Merged

BittuBarnwal7479 added a commit to BittuBarnwal7479/npmx.dev that referenced this pull request Jun 27, 2026

docs: add missing changelog and timeline routes (npmx-dev#2906 )

1b20edf

Co-authored-by: Your Name <your@email.com>

ayo-run pushed a commit to ayo-run/npmx.dev that referenced this pull request Aug 5, 2026

docs: add missing changelog and timeline routes (npmx-dev#2906 )

43e63ef

Co-authored-by: Your Name <your@email.com>

docs: add missing changelog and timeline routes by BittuBarnwal7479 · Pull Request #2906 · npmx-dev/npmx.dev · GitHub

Uh oh!

Uh oh!

docs: add missing changelog and timeline routes - #2906

docs: add missing changelog and timeline routes#2906
serhalp merged 2 commits into
npmx-dev:mainfrom
BittuBarnwal7479:docs/add-missing-routes

BittuBarnwal7479 commented Jun 13, 2026

Uh oh!

vercel Bot commented Jun 13, 2026 •
edited
Loading

Uh oh!

Uh oh!

coderabbitai Bot commented Jun 13, 2026 •
edited
Loading

Uh oh!

Uh oh!

codecov Bot commented Jun 13, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

trueberryless commented Jun 13, 2026

Uh oh!

BittuBarnwal7479 commented Jun 13, 2026

Uh oh!

coderabbitai Bot commented Jun 13, 2026 •
edited
Loading

Uh oh!

Uh oh!

serhalp left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

docs: add missing changelog and timeline routes by BittuBarnwal7479 · Pull Request #2906 · npmx-dev/npmx.dev · GitHub

Uh oh!

Uh oh!

docs: add missing changelog and timeline routes - #2906

docs: add missing changelog and timeline routes#2906serhalp merged 2 commits intonpmx-dev:mainnpmx-dev/npmx.dev:mainfrom BittuBarnwal7479:docs/add-missing-routesBittuBarnwal7479/npmx.dev:docs/add-missing-routesCopy head branch name to clipboard

Conversation

BittuBarnwal7479 commented Jun 13, 2026

🔗 Linked issue

🧭 Context

📚 Description

Uh oh!

vercel Bot commented Jun 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jun 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Walkthrough

Changes

Possibly related issues

Possibly related PRs

Suggested reviewers

Uh oh!

codecov Bot commented Jun 13, 2026

Codecov Report

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

trueberryless commented Jun 13, 2026

Uh oh!

BittuBarnwal7479 commented Jun 13, 2026

Uh oh!

coderabbitai Bot commented Jun 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

serhalp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

docs: add missing changelog and timeline routes#2906
serhalp merged 2 commits into
npmx-dev:mainfrom
BittuBarnwal7479:docs/add-missing-routes

vercel Bot commented Jun 13, 2026 •
edited
Loading

coderabbitai Bot commented Jun 13, 2026 •
edited
Loading

coderabbitai Bot commented Jun 13, 2026 •
edited
Loading