Announcements Manifest

The production announcement feed is published from:

https://docs.borgui.com/announcements.json

This file is sourced from docs/announcements.json because GitHub Pages in this repository publishes the docs/ site.

Update Flow

1. Edit docs/announcements.json.
2. Commit and push to main.
3. Wait for GitHub Pages to rebuild.
4. Verify the live manifest URL returns JSON.

Localization

Announcement translations should live in the manifest itself, not in the app locale files.

Use the base fields as the default fallback:

• title
• message
• highlights
• cta_label

Then add optional localized overrides:

• title_localized
• message_localized
• highlights_localized
• cta_label_localized

Example:

{
  "id": "release-2.0.0-whats-new",
  "type": "release_highlight",
  "title": "What's new in 2.0.0",
  "title_localized": {
    "es": "Novedades de la version 2.0.0",
    "de": "Neu in 2.0.0"
  },
  "message": "Borg UI 2.0.0 adds built-in plans and Borg 2 support.",
  "message_localized": {
    "es": "Borg UI 2.0.0 agrega planes integrados y soporte para Borg 2."
  },
  "highlights": ["Built-in plans", "Borg 2 support"],
  "highlights_localized": {
    "es": ["Planes integrados", "Soporte para Borg 2"]
  },
  "cta_label": "View release notes",
  "cta_label_localized": {
    "es": "Ver notas de la version"
  }
}

Resolution order is:

1. exact locale, e.g. es-ES
2. base language, e.g. es
3. default
4. the base field

Local Development

Local frontend development does not use frontend/public/announcements.json automatically.

The app defaults to the published GitHub Pages manifest unless VITE_ANNOUNCEMENTS_URL is explicitly set.

To turn local announcements on for testing:

1. Start the frontend with VITE_ANNOUNCEMENTS_URL=/announcements.json.
2. Clear any announcement:* localStorage keys if the modal was previously acknowledged or snoozed.