Translate release notes
Add release-note languages, write platform overrides, and understand fallback behavior.
Each release stores its own translations. A locale is a language code such as en or a language-and-region code such as de-DE. VibeUpdate chooses from the notes you write; adding a locale does not translate the text automatically.
Add or edit a translation
- Open your app's Releases tab, then select a release. You can also add translations while creating a new release.
- Enter a valid locale code in Translation locale, such as
frorpt-BR. - Select Add locale.
- Write Shared changelog (Markdown) for that language.
- If the platforms need different notes, fill in iOS override (optional) or Android override (optional).
- Use the locale buttons to switch between translations and review each one.
- Select Save changes, or Save draft for a new release.
Saving changes to a published release updates its live notes. There is no separate publishing step for a translation.
Use hyphens in locale codes, not underscores. Codes are normalized on save, so de-de becomes de-DE. Do not add multiple entries that normalize to the same code, such as en-US and en-us; saving rejects duplicate locales.
Shared notes and platform overrides
Shared notes are the default text for both platforms. An override replaces the shared notes for that platform; it is not appended to them. Include the full message you want that platform's users to read.
For example, a release can have English shared notes about a redesigned home screen and an iOS override that also mentions an iOS-only fix. Android uses the shared notes unless it has its own override.
Publishing requires non-empty shared notes in the app's Default locale, even when both platform overrides are complete. Drafts can contain unfinished notes.
How VibeUpdate chooses a language
For each release, VibeUpdate first looks for a translation matching the requested locale exactly. If there is no exact translation, it looks for the base language. For a request for fr-CA, the base language is fr.
For an iOS or Android view, it then uses the first available text in this order:
- The selected translation's override for that platform.
- The selected translation's shared notes.
- The app default locale's override for that platform.
- The app default locale's shared notes.
A regional sibling is not a base-language translation. If the request is pt-BR, an entry for pt-PT does not match. Add pt for a general Portuguese fallback, or pt-BR for that region.
An exact locale entry takes precedence even when its text is empty. If it has neither shared notes nor an applicable override, VibeUpdate falls back to the app default rather than trying the base-language entry. Remove an unfinished exact entry if you want its base-language translation to be used.
Language on the public page
The public changelog initially uses the browser's requested language unless its link specifies another locale. Visitors can choose Language to change it. Different releases can fall back to different stored translations, so selecting a language does not guarantee that every release has notes in that language.
The All platform view uses shared notes only. The iOS and Android views can use overrides. See public changelog.
Language in the mobile prompt
The SDK's buttons and headings use separate built-in translations. They fall back to English rather than the app's default release-note locale. Your mobile integration can override that interface text locally. See Component props.
Remove a translation
If the release is published, removing a translation changes what readers receive on fallback. You must retain non-empty shared notes in the app's default locale.
- Open the release and select the locale button you want to remove.
- Select Remove followed by that locale code, for example Remove fr.
- Select Save changes.
The remove action appears only when the release has more than one locale. You cannot save a release with no translations.
Change the app's default locale
Changing the default affects every release's fallback. Prepare the new language before changing the setting.
- Add the new locale and non-empty shared notes to each published release, then save each release.
- Open the app's Settings.
- Change Default locale and select Save changes.
- Add the new default-locale notes to any remaining drafts before publishing them.
If saving the setting reports that default-locale shared notes are required, a release still lacks them. Previously published releases in Recently deleted can also prevent the change while their targets retain published status. Avoid restoring a deleted release just to clear this error without reviewing its effect: restoration can make its targets live again.
Write supported Markdown
Use headings, paragraphs, lists, bold or italic text, and links for release notes. Use full https:// links or mailto: links. HTML tags and inline images are removed when notes are saved; unsupported link destinations do not remain clickable.
The mobile prompt does not format inline code or fenced code blocks. Text inside angle brackets can be removed on save, including inside a code example. Use plain-language notes rather than code snippets.
After saving, reopen the release to review the stored text. For published notes on an enabled public page, use Preview public page and check the relevant language and platform. That page does not preview drafts or the mobile prompt's formatting.