Skip to content

docs(user): document the per-viewer display time zone - #312

Merged
pat-s merged 1 commit into
mainfrom
docs/timezone-configuration
Aug 14, 2026
Merged

docs(user): document the per-viewer display time zone#312
pat-s merged 1 commit into
mainfrom
docs/timezone-configuration

Conversation

@pat-s

@pat-s pat-s commented Aug 6, 2026

Copy link
Copy Markdown
Member

Document the time zone every log timestamp is rendered in, which comes from the viewer's browser and can be overridden in Profile → Time Zone.

Details

Rewritten to follow ricochet-rs/ricochet#1238, which shipped the feature. The earlier version of this PR documented a top-level timezone config key from ricochet-rs/ricochet#1233, which was closed unmerged. No such key exists on main, so the admin configuration page and its LinkCard are gone.

New page

src/content/docs/dev/user/time-zone.mdx, listed in the sidebar under User right after Quickstart, covers:

  • Setting the zone from Profile → Time Zone, either by picking from the searchable list or pressing Detect.
  • Precedence: the explicit choice, kept in a timezone cookie for a year, then the zone the browser reports, then UTC.
  • That only an explicit choice is persisted, so a merely detected zone re-detects on a later visit from elsewhere, and that the choice lives in the browser rather than the account.
  • What converts: the per-line clock in streamed runtime, task run, and deployment logs.
  • What stays UTC and is labeled as such: run and deployment listings, execution environment validation times, the database, log files on disk, ricochet's own server logs, and audit records.
  • That cron schedules are still evaluated in UTC, consistent with the existing note in Scheduling Tasks.
  • That the zone list is read from the server's IANA database, and that an Alpine-based image needs tzdata for it to be available.

Verification

bun run build:astro completes, 270 pages build, and Starlight's link validation passes, including the new /dev/user/time-zone/ route and its outbound link to the scheduling page.
prek run --all-files is clean and scripts/semantic-breaks.mjs reports no changes needed.

@ricochet-bot

ricochet-bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Surge PR preview deployment succeeded. View it at https://ricochet-rs-docs-pr-312.surge.sh

The time zone every log timestamp is rendered in comes from the browser
and can be overridden in Profile, so document it as a user setting rather
than a server configuration key.
@pat-s
pat-s force-pushed the docs/timezone-configuration branch from 1758b43 to 7651998 Compare August 12, 2026 06:59
@pat-s pat-s changed the title docs(admin): document the display timezone setting docs(user): document the per-viewer display time zone Aug 12, 2026
@pat-s
pat-s requested a review from JosiahParry August 12, 2026 08:04
@pat-s

pat-s commented Aug 14, 2026

Copy link
Copy Markdown
Member Author

Merging so it's up-to-date with v0.17.0.

@pat-s
pat-s merged commit 674820e into main Aug 14, 2026
2 checks passed
@pat-s
pat-s deleted the docs/timezone-configuration branch August 14, 2026 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants