Skip to content

[P3.5] Sweep stale docs, docstrings and phantom CLI commands, with a repeatable check #972

Description

@frankbria

Filed by the SaaS launch review. Priority P3.5 — severity low, category docs.

Problem

Every stale line is a support ticket or a wasted agent turn. QUICKSTART documents codeframe work batch cancel (the command is stop); GOLDEN_PATH — the document CLAUDE.md declares binding — lists codeframe prd refine, which was never built; CLI_WIREFRAME lists config init/show/set, tasks get status and git status, none of which exist. CLAUDE.md says '16 v2 router modules' (verified: 26 files in routers/). cancel_batch's docstring claims it SIGTERMs running subprocesses when it only flips status; installer.py advertises rollback and confirmation prompts that do not exist; cli/init.py misstates the console-script entry point; CLAUDE.md documents CODEFRAME_API_KEY_SECRET, which no code path reads.

Evidence

  • docs/QUICKSTART.md:276
  • docs/GOLDEN_PATH.md:101
  • docs/CLI_WIREFRAME.md:193
  • CLAUDE.md:135
  • codeframe/core/conductor.py:877
  • codeframe/core/installer.py:7
  • CLAUDE.md:317

Acceptance criteria

  • Every backticked cf/codeframe command in docs/ either exists in cf --help or is explicitly marked NOT IMPLEMENTED
  • CLAUDE.md router count matches the filesystem; CODEFRAME_API_KEY_SECRET is wired or removed from the docs
  • cancel_batch, installer.py and cli/init.py docstrings describe only what the code does
  • A repeatable script or test asserts every documented command resolves in the Typer app

Dependencies


Atomic by construction: one developer, one focused session.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3-post-betaLow priority - can wait until after beta (v2.0)documentationImprovements or additions to documentationpriority:low

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions