Skip to content

fix(changelog): Fix 404 on /changelog/ page and add navigation#17182

Open
sfanahata wants to merge 2 commits intomasterfrom
fix/changelog-404
Open

fix(changelog): Fix 404 on /changelog/ page and add navigation#17182
sfanahata wants to merge 2 commits intomasterfrom
fix/changelog-404

Conversation

@sfanahata
Copy link
Copy Markdown
Contributor

@sfanahata sfanahata commented Mar 30, 2026

  • Add /changelog/ page showing recent documentation updates
  • Add GitHub Action to generate changelog from merged PRs daily
  • Add "Docs Changelog" to Manage dropdown and mobile nav
  • Rename existing changelog links to "Product Changelog" for clarity
  • Generate markdown with links to actual doc pages (not filenames)
  • Skip large PRs (100+ files) to avoid incomplete data

Preview: https://sentry-docs-git-fix-changelog-404.sentry.dev/changelog/

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 30, 2026

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Mar 31, 2026 11:16pm
sentry-docs Ready Ready Preview, Comment Mar 31, 2026 11:16pm

Request Review

Copy link
Copy Markdown
Contributor

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Autofix Details

Bugbot Autofix prepared a fix for the issue found in the latest run.

  • ✅ Fixed: File filter condition is too permissive using OR
    • Changed filter logic from OR to AND, requiring files to both start with docs/ and match .mdx extension, consistent with getPageTitle and fileToUrl functions.

Create PR

Or push these changes by commenting:

@cursor push c32dcdac49
Preview (c32dcdac49)
diff --git a/scripts/update-docs-changelog.mjs b/scripts/update-docs-changelog.mjs
--- a/scripts/update-docs-changelog.mjs
+++ b/scripts/update-docs-changelog.mjs
@@ -189,7 +189,7 @@
 
   for (const file of files) {
     // Only include doc files
-    if (!file.filename.match(/\.(mdx?|tsx?)$/) && !file.filename.startsWith('docs/')) {
+    if (!file.filename.startsWith('docs/') || !file.filename.match(/\.mdx?$/)) {
       continue;
     }

This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.

@sergical
Copy link
Copy Markdown
Member

@sfanahata lots of unrelated changes to backlog (formatting, etc) - do you know why these are ending up here?

Copy link
Copy Markdown
Member

@sergical sergical left a comment

Choose a reason for hiding this comment

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

something is telling me a daily cron that checks all PRs and scans files and parses all of that isn't the right solution here. I might be wrong, but have we considered just doing a standard Changelog.md that can be fetched on the changelog page and rendered nicely as markdown (or even consumed directly using mdx).

Wondering what decision caused us to pursue this route. I am not 100% against it but I am not 100% aligned either 😅

@sfanahata
Copy link
Copy Markdown
Contributor Author

sfanahata commented Mar 31, 2026

@sergical

lots of unrelated changes to backlog (formatting, etc) - do you know why these are ending up here?

Good catch. This was implemented so I could test the formatting locally. I didn't realize it was bloating the PR. I removed it.

Oh, and a rebase pulled all the commits in. 🤦

@sfanahata
Copy link
Copy Markdown
Contributor Author

@sergical

have we considered just doing a standard Changelog.md that can be fetched on the changelog page and rendered nicely as markdown (or even consumed directly using mdx).

Wondering what decision caused us to pursue this route. I am not 100% against it but I am not 100% aligned either 😅

I was exploring still having the changelog accessible to other services (via API), but I don't think we need that anymore. I've had the solution rewritten to your recommendation. Seems to still look good. Will ping you when it's ready for re-review.

- Add /changelog/ page showing recent documentation updates
- Add GitHub Action to fetch merged PRs and generate changelog
- Generate MDX include file with links to actual doc pages
- Add 'Docs Changelog' to navigation dropdown
- Rename existing 'Changelog' links to 'Product Changelog'

The workflow runs daily and creates PRs to update the changelog
with recently merged documentation changes.
Copy link
Copy Markdown
Contributor

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

@coolguyzone
Copy link
Copy Markdown
Contributor

@sfanahata looks good! Is there a way to make it a little more human-readable? The previous version was providing brief LLM-generated summaries describing the changes in the PR, I felt like that was valuable.

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