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.

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.

Back to top

Copyright © 2024 Karan Hudia. Distributed under the AGPL-3.0 License.

This site uses Just the Docs, a documentation theme for Jekyll.