Module guide
Release notes
The Atlas product changelog, in the app and on its own page.
Overview
Records every shipped release. Any authenticated user can draft and publish. A short panel announces each new release in the app once, and the account menu can summon it at any time. The full archive lives at /release-notes.
Highlights
The capabilities worth knowing before you dive in.
- Version strings are validated as semantic versioning; a duplicate returns a conflict
- The highlights list is what the in-app panel shows
- The panel announces itself once per release, and never twice in one session
- What is new in the account menu opens the newest release on demand, whether or not you have read it
- In-app announcements can be turned off and back on in Settings, Notifications
Important to know
Limits, permissions, and sharp edges to keep in mind.
- Release notes are global in scope, so every workspace reads the same feed.
- Author permissions are not yet restricted: any authenticated user can create and publish.
- Turning the announcements off stops the automatic panel only. The account menu still opens the newest release, and the archive at /release-notes is always available.
How to use it
The primary workflow, start to finish.
- Go to /release-notes/admin to draft a release.
- Select Publish. The release appears at /release-notes immediately and begins announcing itself in the app.
- To read the newest release at any time, open the account menu and select What is new.
- To stop the automatic announcement, open Settings, then Notifications, and turn off In-app release announcements. The same switch turns it back on.
FAQ
- What does Do not show again do?
- It turns the automatic announcement off for your account, for every future release. It is not a per-release dismissal. To turn it back on, open Settings, then Notifications, and enable In-app release announcements.
- I turned announcements off. Can I still read the release notes?
- Yes. The account menu item What is new opens the newest release whatever your setting says, and the full archive is always at /release-notes.
- What does Remind me next login do?
- It hides the panel for the rest of the current session only. Signing out and back in shows it again. It changes no stored preference.
- Can I stop one workspace from seeing a release note?
- No. Release notes are global in scope, so every workspace reads the same feed. Write them for the whole audience, and keep anything workspace specific in a channel that supports it.
- Why did publishing a release note report a conflict?
- The version string must be valid semantic versioning and must be unique. Publishing a version that already exists reports a conflict rather than creating a second entry. Increment the version and publish again.
Automate this module
Everything on this screen is scriptable. Drive it from the REST API, or let an AI agent run it through the MCP server.
Was this page helpful?