This is a public-facing repository for Braze release notes. It highlights what is new at Braze and is maintained by the Braze Docs team.
Public markdown documentation is mirrored from www.braze.com/docs using each page's rendered index.md endpoint.
- Sync cadence: weekdays (Monday through Friday, automated; Saturday and Sunday changes roll into Monday's pull request)
- Manual sync: workflow dispatch available in GitHub Actions
- Branch behavior: workflow commits mirrored content to the
docs-sync/public-docs-mirrorbranch and opens (or updates) a pull request tomain; a Docs team reviewer approves and merges the PR to updatemain - Destination structure:
docs/User Guide,docs/Developer Guide,docs/API,docs/Technology Partners, anddocs/What's New - Change reports: daily change log written to
changes/YYYY-MM-DD.md
For a full technical reference, including a line-by-line walkthrough of the workflow and sync script, see ARCHITECTURE.md.
You can subscribe to repository updates from the Watch menu on GitHub.
- Open this repository on GitHub.
- Select Watch.
- Choose a notification level:
- All Activity: Notify on all activity.
- Participating and @mentions: Notify only when you are directly involved.
- Custom: Choose specific events.
GitHub can send alerts through the web UI and email, based on your personal notification settings.
To manage alerts:
- Go to GitHub Settings.
- Open Notifications.
- Configure:
- Email and web notifications
- Watched repository behavior
- Notification routing and filtering
For details, see GitHub notifications documentation.