Skip to content

chore(docs): refresh README + env.example for phases 4–5 shipped#77

Merged
Copxer merged 1 commit into
mainfrom
chore/readme-and-env-phase-5-update
May 1, 2026
Merged

chore(docs): refresh README + env.example for phases 4–5 shipped#77
Copxer merged 1 commit into
mainfrom
chore/readme-and-env-phase-5-update

Conversation

@Copxer
Copy link
Copy Markdown
Owner

@Copxer Copxer commented May 1, 2026

Catches up the user-facing docs after phase 4 + phase 5 closed out. No code changes.

Summary

  • Phase status table flips rows 4 + 5 from ⬜ → 🟢 with one-line per-spec summaries (020–022 deployments, 023–025 monitoring).
  • "What works today" gains two new sections — Phase 4 (deployments — workflow runs storage + cross-repo timeline UI with Reverb realtime + Overview success-rate widget) and Phase 5 (monitoring — CRUD + scheduled checks + uptime aggregates + Overview uptime KPI + per-website Reverb live updates).
  • composer dev callout now notes the scheduler tick is what drives spec 024's monitor probes — without it (or a real cron), monitors stay on whatever state the last manual probe left them in.
  • Repository layout adds the new bounded contexts + directories that shipped:
    • app/Domain/Monitoring/ (with Probes/ for the result DTO),
    • app/Events/ (the three broadcast classes — ActivityEventCreated, WorkflowRunUpserted, WebsiteCheckRecorded),
    • app/Policies/ (Project / Repository / Website),
    • Pages/Deployments/ + Pages/Monitoring/Websites/,
    • lib/workflowRunStyles.ts + lib/websiteStyles.ts (shared tone helpers).
  • .env.example BROADCAST_CONNECTION comment lists all three live broadcast events instead of just spec 019. No new env keys shipped in phases 4 or 5; AGENT_SHARED_SECRET stays as the pre-seeded placeholder for phase 6.

Test plan

  • No code changes — Pint / tests / build are unaffected.
  • Visual scan: phase status table, "What works today" sections, repository layout diagram render correctly on GitHub.

Note

Pure documentation. Squash-merging this is fine without the usual self-review pass; the diff is two files and ~50 lines.

- Phase status table flips 4 + 5 from ⬜ to 🟢 with one-line per-spec
  summaries.
- "What works today" gains Phase 4 (deployments — workflow runs
  storage + timeline UI + Overview success-rate widget) and Phase 5
  (website monitoring — monitor MVP + scheduled checks + Overview
  uptime KPI + Reverb live updates) sections.
- composer dev callout notes the scheduler tick is what drives spec
  024's monitor probes — without it (or a real cron), monitors stay
  on whatever state the last manual probe left them in.
- Repository layout adds the new bounded contexts + directories that
  shipped (Domain/Monitoring with its Probes/, Events/ for the three
  broadcast classes, Policies/, Pages/Deployments + Pages/Monitoring,
  lib/{workflowRunStyles,websiteStyles}.ts).
- env.example BROADCAST_CONNECTION comment lists all three live
  broadcast events (ActivityEventCreated, WorkflowRunUpserted,
  WebsiteCheckRecorded) instead of just spec 019. No new env keys
  shipped in phases 4 or 5; AGENT_SHARED_SECRET stays as the
  placeholder for phase 6.
@Copxer Copxer merged commit 0c2b903 into main May 1, 2026
1 check passed
@Copxer Copxer deleted the chore/readme-and-env-phase-5-update branch May 1, 2026 07:54
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.

1 participant