Skip to content

README describes ~5 components that don't exist on the current branch (pre-public-repo risk) #86

Description

@bjridicodes

Severity: Medium — blocks the public-repo cutover (M6.5)

Source: CTO codebase review, 2026-06-10.

The issue

The README is an excellent vision document but has drifted from the actual tree. It presents these as shipped, but they are absent on the current branch:

  • Dockerfile, deployment/monolithic/ (README lines ~421, 428) — absent (S3 deliverable)
  • api/static/dashboard/ and api/routers/monitoring.py (lines ~380, 388) — absent (S2 deliverable)
  • implementations/llm/vertex_ai/ / VertexAILLMClient (line ~412) — absent; only anthropic/ and claude_code/ exist (S3 deliverable)
  • implementations/coms/teams/, google_chat/, telegram/ — README marks Teams/Google Chat as ✅ Full; verify — only slack and whatsapp appeared in the file scan

Why it matters

This repo is going public (M6.5). A contributor clones it, runs docker build, and immediately hits a missing file. A roadmap-shaped README that mixes destination with HEAD erodes first-contact trust.

Proposed fix

  • Split "implemented now" from "planned" with an unambiguous marker throughout the README.
  • Gate the public-repo cutover (M6.5) on the README matching the actual tree — add this as an explicit checklist item.

Note

Most of these are legitimately P1.5 S2/S3 deliverables — the README is describing the destination, which is fine as a roadmap but not as a HEAD description.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationphase-1.5All Phase 1.5 issues

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions