Skip to content

docs: add missing changelog and timeline routes - #2906

Merged
serhalp merged 2 commits into
npmx-dev:mainfrom
BittuBarnwal7479:docs/add-missing-routes
Jun 14, 2026
Merged

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

Conversation

@BittuBarnwal7479

Copy link
Copy Markdown
Contributor

🔗 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+

@vercel

vercelBot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

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

ProjectDeploymentActionsUpdated (UTC)
npmx.devReadyReadyPreview, CommentJun 13, 2026 8:20pm
2 Skipped Deployments
ProjectDeploymentActionsUpdated (UTC)
docs.npmx.devIgnoredIgnoredPreviewJun 13, 2026 8:20pm
npmx-lunariaIgnoredIgnoredJun 13, 2026 8:20pm

Request Review

@coderabbitai

coderabbitaiBot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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

Possibly related PRs

Suggested reviewers

  • ghostdevv
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check nameStatusExplanation
Title check✅ PassedThe title accurately describes the main change: adding missing changelog and timeline routes to the documentation.
Description check✅ PassedThe description is related to the changeset, explaining that missing route entries were added to CONTRIBUTING.md for changelog and timeline pages.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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

codecovBot commented Jun 13, 2026

Copy link
Copy Markdown

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!

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Comment threadCONTRIBUTING.md Outdated
@trueberryless

Copy link
Copy Markdown
Member

Please you resolve this comment?

@BittuBarnwal7479

Copy link
Copy Markdown
ContributorAuthor

@CodeRabbit review.

@coderabbitai

coderabbitaiBot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor
🧩 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 namePatternParams
changelog/package-changelog/:org?/:nameorg?, name
changelog-version/package-changelog/:org?/:name/v/:versionorg?, name, version
timeline/package-timeline/:org?/:packageName/v/:versionorg?, 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.

@serhalpserhalp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

@serhalp
serhalp added this pull request to the merge queueJun 14, 2026
Merged via the queue into npmx-dev:main with commit ab3313aJun 14, 2026
24 checks passed
@github-actionsgithub-actionsBot mentioned this pull request Jun 14, 2026
BittuBarnwal7479 added a commit to BittuBarnwal7479/npmx.dev that referenced this pull request Jun 27, 2026
ayo-run pushed a commit to ayo-run/npmx.dev that referenced this pull request Aug 5, 2026
Sign up for freeto 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.

3 participants

@BittuBarnwal7479@trueberryless@serhalp