Files
kandev/docs/plans/ws-connectivity-warning/task-05-public-documentation.md
T
2026-08-24 11:09:03 +00:00

2.0 KiB

id, title, status, wave, depends_on, plan, spec
id title status wave depends_on plan spec
05-public-documentation Public documentation done 4
02-desktop-warning-surfaces
03-mobile-warning-surfaces
plan.md ../../specs/ui/requirements/ws-connectivity-warning.md

Task 05: Public documentation

Acceptance

  • Operations docs explain the 3-second yellow and 10-second red states, where the warning appears with App status bar enabled/disabled, and that red means live data may be stale.
  • Configuration docs keep features.app_status_bar accurate: it controls the general-purpose surface but not urgent connectivity fallback visibility.
  • Public-doc validation passes with no new page or navigation entry.

Verification

node --test scripts/validate-public-docs.test.mjs
node scripts/validate-public-docs.mjs

Completion report

  • Public docs: updated the operations and configuration guidance for the 3-second yellow state, 10-second red state, stale-data warning, and urgent fallback when the general status bar is off.
  • Validator tests: passed — 58 tests.
  • Published-doc validation: passed — 41 pages validated.
  • Blockers: none.
  • Remaining risk: none beyond keeping the documented thresholds and feature-toggle behavior in sync with future connectivity UI changes.

Files likely touched

  • docs/public/operations.md
  • docs/public/configuration.md

Dependencies

Tasks 02 and 03.

Parallelism

Sequential so terminology matches the landed UI.

Inputs

  • Spec: What, Failure modes, and Out of scope.
  • Plan: Public documentation.
  • Existing Feature toggles and troubleshooting sections in docs/public/operations.md.

Risks

  • Do not imply that features.app_status_bar=false mounts plugins or metrics during an outage.
  • Keep the warning distinct from /health, System Status, executor health, and integration health.

Output contract

Report public docs changed, exact validation results, blockers/risks, then mark this task done and update its checkbox in plan.md.