docs: fix v0.2.0 release-audit documentation drift - #601
Merged
Conversation
Nine evidence-backed fixes from a v0.2.0 documentation/runbook audit: 1. Migration range 0072-0078 corrected to 0072-0080 (COMPOSE.md, upgrade-and-rollback.md), and the "GO2RTC_AUTH is the only new key" claim reworded to also mention MAIN_REPAIR_TRANSCODE_ENABLED. 2. Secrets docs no longer claim GO2RTC_USER_FILE/GO2RTC_PASS_FILE work, those two don't support the _FILE convention end to end (embedded go2rtc reads process env directly, compose requires the plain vars). 3. Removed the nonexistent scripts/setup-env.sh --print flag from OPS-DEPLOY.md; pointed at the passphrase already sitting in .env instead. 4. Corrected the stale DB_POOL_SIZE guidance in OPS-DEPLOY.md, it is already forwarded by the stock docker-compose.yml. 5. Added a note to OPS-DEPLOY.md and OPS-BACKUP-RECOVERY.md that automated nightly backups are on by default (docs/BACKUP.md); scripts/backup-db.sh is framed as the supplemental/ad-hoc path. 6. Forwarded SEGMENT_RECEIPT_TIMEOUT_SECS in docker-compose.yml's recorder environment block so the recorder's log advice to raise it is actually true (unset/unparseable safely falls back to the internal default, confirmed in recording.rs); documented it in .env.example and the environment reference. 7. Rewrote ROADMAP.md's stale "where we are today" for the notification system (a full rules/channels/history engine already shipped) and prebuilt distribution (GHCR + signed Android releases are live), checking off the phase-checklist items that are actually done. 8. Documented plate naming and copy-plate-number on the LPR docs page, shipped on all four clients. 9. Corrected the Android mainv-first stream-fallback order and the served-vs-producer SDP detection detail in COMPONENT-MAP.md, and added a correction addendum to the DECISIONS.md entry. Signed-off-by: badbread <badbread@users.noreply.github.com>
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
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.
Summary
Nine evidence-backed fixes from a v0.2.0 documentation/runbook audit. No code changes except forwarding
SEGMENT_RECEIPT_TIMEOUT_SECSthrough compose (item 6) so an existing recorder log line's advice is actually true.docs/COMPOSE.md,docs-site/docs/getting-started/upgrade-and-rollback.md). Also reworded COMPOSE.md's "GO2RTC_AUTH is the only new key" to mentionMAIN_REPAIR_TRANSCODE_ENABLEDtoo._FILEsupport for go2rtc credentials.GO2RTC_USER_FILE/GO2RTC_PASS_FILEdon't work end to end (the embedded go2rtc reads the plain env vars directly, and compose:?-requires them). Scoped the_FILE-supported list toDATABASE_URL,JWT_SECRET,SEED_ADMIN_PASSWORD,HA_TOKENindocs-site/docs/configuration/secrets.mdandenvironment-reference.md.docs/OPS-DEPLOY.mddocumented a nonexistentscripts/setup-env.sh --printflag. The parser only accepts--force/--prompt/-h. Replaced with the actual way to see the passphrase again (it's in.envasSEED_ADMIN_PASSWORD).DB_POOL_SIZEguidance.docs/OPS-DEPLOY.mdsaid it needed hand-wiring into the environment blocks; the stock compose already forwards it and.env.examplecarries the commented key.docs/OPS-DEPLOY.mdanddocs/OPS-BACKUP-RECOVERY.mdonly taught the manualscripts/backup-db.sh+ cron path and never mentioned the api's built-in nightlypg_dump(on by default). Added a note to both framing the manual script as supplemental/ad-hoc.services/recorder/src/recording.rstells the operator to raiseSEGMENT_RECEIPT_TIMEOUT_SECS, but it wasn't in the recorder's composeenvironment:block. Confirmed unset/unparseable safely falls back to the internal default (no panic, no zero-timeout) viaclamp_segment_receipt_timeout_secs, so forwarding it is safe: added it todocker-compose.yml,.env.example, and the environment reference.docs/ROADMAP.md"where we are today" was badly stale. The notification system described as "a single hardcoded webhook watchdog" is actually a full rules/channels/history engine (Discord, Slack, Pushover, Telegram, ntfy, webhook dispatchers; quiet hours; snooze/presence) shipped well before 0.2.0 and redesigned in the console by feat(notifications): redesign the console Notifications pane (channels, alert-text editor, quiet hours) #583. The distribution initiative claimed "no registry wired" and "CI does not build the APK", both shipped (public GHCR, signed Android releases viaandroid-release.yml,version.propertiesat 0.2.0/5). Rewrote the "where we are today" passages and checked off the phase-checklist items that are actually done.docs/COMPONENT-MAP.mdstill documented the pre-fix(android): try the repaired main (mainv) before the doomed raw main #594 fallback order (main -> mainv -> ...); the code is mainv-first after fix(android): try the repaired main (mainv) before the doomed raw main #594. Also corrected the stalesdp_video_lacks_fmtp-on-producer detection detail to the actual served-SDP check (stream_served_video_lacks_fmtp, post-fix(api): flag the _mainv repair from the SERVED SDP, not the producer #592). Added a correction addendum to the relevantdocs/DECISIONS.mdentry (matching its existing addendum style) rather than editing the original decision text.Test plan
docker compose -f docker-compose.yml config -qvalidated clean on dev2 (real Docker, not a YAML parser) with the newSEGMENT_RECEIPT_TIMEOUT_SECSkey rendering correctly