docs(product-updates): add in-app changelog source (product_updates.json)#815
Merged
Conversation
…son) Source of truth for the app's Product Updates drawer — the api-server fetches this file at runtime (raw URL on main, ~30-min cache), so editing the changelog is a docs commit, no app release. Includes a README documenting the schema (slug/title/body/category/url/highlight/is_active/published_at) and the highlight:false convention for non-highlighted historical entries. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces an in-app changelog feature by adding a README documentation file and an initial product_updates.json dataset. The review feedback suggests optimizing the JSON payload by removing redundant default values (such as "highlight": true and "is_active": true) and omitting optional fields set to null to improve maintainability and prevent potential parsing issues.
blue4209211
approved these changes
Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds the source-of-truth changelog for the app's Product Updates drawer (the megaphone icon in the header).
The api-server fetches
product-updates/product_updates.jsonfrom this repo'smainat runtime (raw URL, ~30-min cache) and serves it to every tenant — so editing the changelog is a docs commit; no api-server release. The URL is overridable per-deployment viaPRODUCT_UPDATES_URL, and the app ships an embedded fallback for air-gapped on-prem.Companion app PR: nudgebee/nudgebee-enterprise#31523
What's here
product-updates/product_updates.json— 4 starter entries: 2 current (highlight: true, badge as "New") + 2 historical back-catalog (highlight: false, shown but never highlighted).product-updates/README.md— schema + authoring guide (thehighlight: falseconvention for historical entries,is_activeto retire, RFC3339published_atfor ordering).Notes
slugis the stable unique id;highlight/is_activedefault totrue.🤖 Generated with Claude Code