docs: add Message of the Day page#24
Merged
Merged
Conversation
Document the message-of-the-day (MOTD) feature: an operator-published banner shown ahead of every pilotctl command for one UTC day at a time. Covers what it is, the poll-and-mirror design (daemon fetches the feed, pilotctl reads the local mirror — no per-command network call), text vs --json output (the important_update envelope field), publishing/clearing via the pilot-motd repo, the --motd-feed-url / --motd-interval flags, and UTC semantics. - src/pages/docs/motd.astro: full docs page - src/pages/plain/docs/motd.astro: plain-text mirror - src/data/docsNav.ts: sidebar entry under Operations - configuration.astro / integration.astro: splice prev/next chain Built locally with `npm run build` (301 pages, clean).
|
🚀 Preview deployed to Cloudflare Pages
|
Publishing is restricted to maintainers with push access to the feed; the public docs no longer describe how to post/clear a message. The page still covers what MOTD is, the poll-and-mirror design, text vs --json output, daemon configuration, and UTC/self-clearing semantics.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a docs page for the message-of-the-day (MOTD) feature — an operator-published banner shown ahead of every
pilotctlcommand for one UTC calendar day at a time.Companion to the implementation PRs:
TeoSlayer/pilotprotocol#253 (daemon + CLI)pilot-protocol/pilot-motd#1 (the feed/DB)Pages
src/pages/docs/motd.astro— full page: what it is, the poll-and-mirror design (daemon fetches the feed;pilotctlreads the local mirror, so there's no per-command network/IPC call), text vs--jsonoutput (important_updateenvelope field), publishing/clearing via thepilot-motdrepo, the--motd-feed-url/--motd-intervalflags +PILOT_MOTD_URL, and UTC semantics.src/pages/plain/docs/motd.astro— plain-text mirror, matching the existingplain/docs/*style.Wiring
src/data/docsNav.ts— sidebar entry "Message of the Day" under Operations (after Configuration).configuration.astro/integration.astro— prev/next chain spliced to include the new page.docs/*.astroglob.Test
npm run buildsucceeds locally (301 pages, clean). Verified the builtdist/docs/motd.html+dist/plain/docs/motd.htmlrender, the sidebar link appears on other doc pages, and the page is indist/sitemap.xml.