docs: restart changelog with weekly updates#1478
Conversation
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughRewrites the public CHANGELOG.md into a consolidated "Stack Auth Changelog" (releases 5/22/26–4/17/26) and removes the "## MCP Setup" section from the generated setup prompt text in the getting-started guide and home prompt snippet. ChangesDocumentation updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Greptile SummaryThis PR restarts the
Confidence Score: 4/5Safe to merge; changes are documentation only with no runtime impact. The changelog rewrite is straightforward documentation with no code changes. Two of the six weekly screenshots have alt-text and content that don't match their sections, which could confuse readers, but this doesn't block merging. CHANGELOG.md — verify the intended screenshots for the 5/8/26 and 4/17/26 entries before publishing. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
CL["CHANGELOG.md"] --> W1["5/22/26\nMetrics · cross-domain · auth polish"]
CL --> W2["5/15/26\nProject transfer · AI chat · teams"]
CL --> W3["5/8/26\nTanStack Start · CLI · metrics"]
CL --> W4["5/1/26\nSession replays · data grids · emulator"]
CL --> W5["4/24/26\nEmail server · emulator · sign-up rules"]
CL --> W6["4/17/26\nOverview redesign · sidebar · AI companion"]
W1 -->|image| I1["auth-methods.png ✅"]
W2 -->|image| I2["teams.png ✅"]
W3 -->|image| I3["rbac.png ⚠️ mismatch"]
W4 -->|image| I4["data-vault.png ✅"]
W5 -->|image| I5["email-server.png ✅"]
W6 -->|image| I6["payments-products.png ⚠️ mismatch"]
Prompt To Fix All With AIFix the following 3 code review issues. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 3
CHANGELOG.md:49
Typo in the footer note: "source of true" should be "source of truth". This is a pre-existing typo that this PR has an opportunity to fix since it touches the surrounding lines.
```suggestion
> **Note:** All older changelogs are deprecated and have been removed. The source of truth is this single changelog file.
```
### Issue 2 of 3
CHANGELOG.md:40-45
**Image doesn't match section content** — the `4/17/26` entry describes the overview redesign, sidebar navigation, and AI in Stack Companion, but the attached image is labeled "Payments product setup" (`payments-products.png`). A reader scanning this section won't see any payments context in the bullets to explain the screenshot. If this image was meant for a different week's entry, swapping it to the correct section would prevent confusion.
### Issue 3 of 3
CHANGELOG.md:19-24
**Image caption mismatches section topic** — the `5/8/26` entry covers TanStack Start SDK integration, weekly user metrics, and Stack CLI improvements, but the image is labeled "RBAC permissions dashboard" (`rbac.png`). RBAC is not mentioned in any of the bullets for this week. Double-check whether this screenshot belongs to a different entry.
Reviews (1): Last reviewed commit: "docs: use plain changelog screenshots" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
|
||
| --- | ||
|
|
||
| > **Note:** All older changelogs are deprecated and have been removed. The source of true is this single changelog file. |
There was a problem hiding this comment.
| > **Note:** All older changelogs are deprecated and have been removed. The source of true is this single changelog file. | |
| > **Note:** All older changelogs are deprecated and have been removed. The source of truth is this single changelog file. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: CHANGELOG.md
Line: 49
Comment:
Typo in the footer note: "source of true" should be "source of truth". This is a pre-existing typo that this PR has an opportunity to fix since it touches the surrounding lines.
```suggestion
> **Note:** All older changelogs are deprecated and have been removed. The source of truth is this single changelog file.
```
How can I resolve this? If you propose a fix, please make it concise.
There was a problem hiding this comment.
Addressed in 13b58e44d: fixed source of true to source of truth.
| ## 4/17/26 | ||
|
|
||
| - The overview page and onboarding experience were redesigned. | ||
| - Dashboard sidebar styling and category navigation were tightened up. | ||
| - AI arrived in Stack Companion with a large-response chat flow. | ||
|  |
There was a problem hiding this comment.
4/17/26 entry describes the overview redesign, sidebar navigation, and AI in Stack Companion, but the attached image is labeled "Payments product setup" (payments-products.png). A reader scanning this section won't see any payments context in the bullets to explain the screenshot. If this image was meant for a different week's entry, swapping it to the correct section would prevent confusion.
Prompt To Fix With AI
This is a comment left during a code review.
Path: CHANGELOG.md
Line: 40-45
Comment:
**Image doesn't match section content** — the `4/17/26` entry describes the overview redesign, sidebar navigation, and AI in Stack Companion, but the attached image is labeled "Payments product setup" (`payments-products.png`). A reader scanning this section won't see any payments context in the bullets to explain the screenshot. If this image was meant for a different week's entry, swapping it to the correct section would prevent confusion.
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
Addressed in 089f1ca56: the 4/17 entry now includes the Payments product setup bullet and the image was moved under apps/dashboard/public/assets/.
| ## 5/8/26 | ||
|
|
||
| ## 1/19/26 | ||
| - Updated package dependencies to their newest versions. | ||
| - TanStack Start SDK integration landed with refreshed OpenAPI schemas. | ||
| - Project overview now shows weekly users metrics. | ||
| - Stack CLI gained self-hosted URL support and clearer cloud/local init next steps. | ||
|  |
There was a problem hiding this comment.
5/8/26 entry covers TanStack Start SDK integration, weekly user metrics, and Stack CLI improvements, but the image is labeled "RBAC permissions dashboard" (rbac.png). RBAC is not mentioned in any of the bullets for this week. Double-check whether this screenshot belongs to a different entry.
Prompt To Fix With AI
This is a comment left during a code review.
Path: CHANGELOG.md
Line: 19-24
Comment:
**Image caption mismatches section topic** — the `5/8/26` entry covers TanStack Start SDK integration, weekly user metrics, and Stack CLI improvements, but the image is labeled "RBAC permissions dashboard" (`rbac.png`). RBAC is not mentioned in any of the bullets for this week. Double-check whether this screenshot belongs to a different entry.
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
Addressed in 089f1ca56: the 5/8 entry now mentions project permissions, and the screenshot/caption points to the matching project permissions dashboard asset.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@CHANGELOG.md`:
- Line 49: The deprecation notice on line containing "The source of true is this
single changelog file." has a typo; change "true" to "truth" so the sentence
reads "The source of truth is this single changelog file." Update that exact
sentence in CHANGELOG.md to fix the misspelling.
- Around line 5-46: The changelog entries under each date heading (e.g., the "##
5/22/26", "## 5/15/26", etc. blocks) lack explicit subsections so the parser
treats all entries as "patch"; update each date section to include explicit "###
Major Changes" and/or "### Minor Changes" subsections (and move the relevant
bullet points into the appropriate subsection) so the parser can classify
properly, or alternatively modify the changelog parser to detect and infer
major/minor from content; target the date headers like "## 5/22/26" and the
bullet lists beneath them when applying this change.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8770ed8a-b57b-472e-828c-876819e50604
⛔ Files ignored due to path filters (6)
apps/dashboard/public/changelog/auth-methods.pngis excluded by!**/*.pngapps/dashboard/public/changelog/data-vault.pngis excluded by!**/*.pngapps/dashboard/public/changelog/email-server.pngis excluded by!**/*.pngapps/dashboard/public/changelog/payments-products.pngis excluded by!**/*.pngapps/dashboard/public/changelog/rbac.pngis excluded by!**/*.pngapps/dashboard/public/changelog/teams.pngis excluded by!**/*.png
📒 Files selected for processing (1)
CHANGELOG.md
| ## 5/22/26 | ||
|
|
||
| ### Payments | ||
| Introduced a redesigned payments onboarding flow | ||
|  | ||
| - Project metrics and preview analytics now lean harder on ClickHouse. | ||
| - Cross-domain handoffs and hosted-domain trust received production polish. | ||
| - Auth method and user-table surfaces got another round of dashboard polish. | ||
|  | ||
|
|
||
| ## 1/21/26 | ||
| ## 5/15/26 | ||
|
|
||
| ### Payments | ||
| - Payments page updated with new UI changes | ||
|  | ||
| - Added a new Payments Settings page with an option to temporarily disable all payments | ||
|  | ||
| - Subscription renewal emails are now sent automatically to users | ||
| - Past payment invoices are now visible on the Account Settings page | ||
|  | ||
| - Project transfer, session replay, and team payments screens were redesigned. | ||
| - AI chat surfaces were unified on assistant-ui threads. | ||
| - Team management views picked up cleaner tables and action states. | ||
|  | ||
|
|
||
| ### Documentation | ||
| - Updated JWT documentation to include `isRestricted` and `restrictedReason` | ||
| ## 5/8/26 | ||
|
|
||
| ## 1/19/26 | ||
| - Updated package dependencies to their newest versions. | ||
| - TanStack Start SDK integration landed with refreshed OpenAPI schemas. | ||
| - Project overview now shows weekly users metrics. | ||
| - Stack CLI gained self-hosted URL support and clearer cloud/local init next steps. | ||
|  | ||
|
|
||
| ## 12/19/25 | ||
| - Introduces new changelog and deprecates all older changelogs. | ||
| - Date versioning for public view. | ||
| ## 5/1/26 | ||
|
|
||
| - Session replays gained shareable IDs across dashboard, backend, and SDK surfaces. | ||
| - Data grids and overview layouts were refactored. | ||
| - The emulator can auto-install dependencies when pulling updates. | ||
|  | ||
|
|
||
| ## 4/24/26 | ||
|
|
||
| - Email Server settings and managed-domain setup were redesigned. | ||
| - Local emulator startup got RAM snapshots and live secret rotation. | ||
| - The sign-up rules tester dialog was simplified. | ||
|  | ||
|
|
||
| ## 4/17/26 | ||
|
|
||
| - The overview page and onboarding experience were redesigned. | ||
| - Dashboard sidebar styling and category navigation were tightened up. | ||
| - AI arrived in Stack Companion with a large-response chat flow. | ||
|  | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify changelog entries can be parsed and check their inferred types
# Search for Major/Minor subsections in the new changelog entries
rg -n "^###\s+(Major|Minor)\s+Changes" CHANGELOG.md
# If no results, all entries will be classified as "patch"
echo "---"
echo "Note: If no subsections found above, all releases will be classified as 'patch' type"Repository: hexclave/stack-auth
Length of output: 152
Changelog entries will all be inferred as “patch”
CHANGELOG.mdhas no### Major Changes/### Minor Changessubsections under the## M/D/YYentries, so the parser will fall back to the default change type.- Add
### Major Changes/### Minor Changessubsections (or adjust the parser) if you want major/minor classification.
🤖 Prompt for 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.
In `@CHANGELOG.md` around lines 5 - 46, The changelog entries under each date
heading (e.g., the "## 5/22/26", "## 5/15/26", etc. blocks) lack explicit
subsections so the parser treats all entries as "patch"; update each date
section to include explicit "### Major Changes" and/or "### Minor Changes"
subsections (and move the relevant bullet points into the appropriate
subsection) so the parser can classify properly, or alternatively modify the
changelog parser to detect and infer major/minor from content; target the date
headers like "## 5/22/26" and the bullet lists beneath them when applying this
change.
There was a problem hiding this comment.
Keeping this bullet-only intentionally per product request (“no ### subcategories”). Parser validation still passes with six date entries, 3+ bullets per entry, and one image per entry.
There was a problem hiding this comment.
Skipped: comment is from another GitHub bot.
|
Moved the changelog screenshots into |
1 participant
Updated CHANGELOG.md from scratch with six weekly entries and images for each week.
Link to Devin session: https://app.devin.ai/sessions/641c4e431b744f3db8c916160245b1be
Requested by: @N2D4
Summary by CodeRabbit