Skip to content

docs: audit and fix README, getting-started, and CLAUDE.md accuracy#916

Merged
aaight merged 2 commits intodevfrom
fix/docs-accuracy-audit
Mar 16, 2026
Merged

docs: audit and fix README, getting-started, and CLAUDE.md accuracy#916
aaight merged 2 commits intodevfrom
fix/docs-accuracy-audit

Conversation

@aaight
Copy link
Copy Markdown
Collaborator

@aaight aaight commented Mar 16, 2026

Summary

Audits and fixes documentation inaccuracies across README.md, docs/getting-started.md, and CLAUDE.md to reflect recent codebase changes.

  • Default engine correctedgetting-started.md incorrectly listed Claude Code as the default engine; actual default is llmist (per src/config/schema.ts PROJECT_DEFAULTS). Engine table reordered and LLMist credential section added first.
  • JIRA config field fixedstatusMapstatuses to match JiraConfigSchema in src/config/schema.ts
  • Stale agentBackend JSON removed from CLAUDE.md — replaced with correct CLI approach (cascade projects update --agent-engine and cascade agents create --engine)
  • Missing DB tables documented — added agent_definitions, prompt_partials, pr_work_items, webhook_logs, agent_trigger_configs to schema section; updated agent_configs and projects descriptions with new columns
  • Missing CLI commands addedruns cancel, definitions (9 cmds), prompts (8 cmds), webhooklogs (2 cmds), plus missing projects update flags (--work-item-budget, --watchdog-timeout, --progress-model, --progress-interval, --run-links-enabled, --max-in-flight-items) and --engine flag for agents create
  • Agent creation section updated — now documents YAML-based definitions workflow with explicit agent_configs requirement
  • Debug agent setup fixed — removed dead config/projects.json JSON snippet; replaced with CLI integration-set approach
  • Misc fixes — Supabase-specific port 6543 reference removed, login URL corrected to port 3001, CLAUDE_CODE_OAUTH_TOKEN "backend" → "engine", Codex BackendCodex Engine section heading, Claude Code BackendClaude Code Engine section heading, npm run dev comment clarified to say Router not Dashboard, CLI directory tree updated with new command groups
  • README — engine listing reordered to show llmist (default) first

Test plan

  • Search for stale terms: agentBackend, statusMap, claude-code.*default, Supabase transaction pooler, Claude Code backend
  • Verify node bin/cascade.js --help output matches documented commands
  • Verify JiraConfigSchema in src/config/schema.ts uses statuses not statusMap
  • Verify PROJECT_DEFAULTS.agentEngine === 'llmist' in src/config/schema.ts

Trello card: https://trello.com/c/PoWDO4Vg/437-lets-make-sure-our-readme-getting-started-and-docs-in-general-are-accurate-given-changes-in-the-repository-over-the-last-couple

🤖 Generated with Claude Code

🕵️ claude-code · claude-sonnet-4-6 · run details

Copy link
Copy Markdown
Collaborator

@nhopeatall nhopeatall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

Solid documentation audit. All key claims verified against source code — every correction is accurate. CI is green.

Verified against source:

  • agentEngine: 'llmist' is the default (confirmed in src/config/schema.ts PROJECT_DEFAULTS)
  • statuses is the correct field name (not statusMap) in JiraConfigSchema
  • agentBackend has zero remaining references in src/
  • ✅ All 5 new DB tables (agent_definitions, prompt_partials, pr_work_items, webhook_logs, agent_trigger_configs) exist in schema
  • ✅ New CLI command groups (definitions/ = 9 files, prompts/ = 8 files, webhooklogs/ = 2 files) all match documented counts
  • runs/cancel.ts exists, --engine flag exists on agents create
  • ✅ All new projects update flags (--work-item-budget, --watchdog-timeout, --progress-model, --progress-interval, --run-links-enabled, --max-in-flight-items) confirmed in src/cli/dashboard/projects/update.ts
  • ✅ Vite dev server proxies to :3001 (confirmed in web/vite.config.ts)
  • config/projects.json is only used by npm run db:seed (via tools/seed-config-from-json.ts)
  • agent_configs columns system_prompt and task_prompt confirmed in schema
  • projects columns squint_db_url, run_links_enabled, max_in_flight_items confirmed in schema

Code Issues

Should Fix

  • CLAUDE.md, CLI directory tree — The runs/ comment says "8 commands" but the parenthetical lists 9 items: list, show, logs, llm-calls, llm-call, debug, trigger, retry, cancel. The actual src/cli/dashboard/runs/ directory also contains 9 .ts files. Should read # 9 commands (...).

🕵️ claude-code · claude-opus-4-6 · run details

The parenthetical already listed 9 commands (list, show, logs, llm-calls,
llm-call, debug, trigger, retry, cancel) but the count said 8. Updated
to match the actual count and the 9 .ts files in src/cli/dashboard/runs/.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@aaight
Copy link
Copy Markdown
Collaborator Author

aaight commented Mar 16, 2026

Fixed! Corrected runs/ comment in the CLI directory tree from # 8 commands to # 9 commands to match both the parenthetical list (list, show, logs, llm-calls, llm-call, debug, trigger, retry, cancel) and the actual 9 .ts files in src/cli/dashboard/runs/.

🕵️ claude-code · claude-sonnet-4-6 · run details

Copy link
Copy Markdown
Collaborator

@nhopeatall nhopeatall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — thorough documentation audit with every factual claim verified against source code.

Verified against codebase:

  • PROJECT_DEFAULTS.agentEngine === 'llmist' in src/config/schema.ts
  • JiraConfigSchema uses statuses (not statusMap) ✓
  • Vite proxy targets port 3001, dashboard defaults to 3001 ✓
  • npm run dev runs src/router/index.ts (Router, not Dashboard) ✓
  • All new CLI command groups exist with correct file counts: definitions/ (9), prompts/ (8), webhooklogs/ (2), runs/cancel
  • All projects update flags (--work-item-budget, --watchdog-timeout, --progress-model, --progress-interval, --run-links-enabled, --max-in-flight-items) exist ✓
  • --engine flag on agents create confirmed ✓
  • All referenced DB tables (agent_definitions, prompt_partials, pr_work_items, webhook_logs, agent_trigger_configs) have corresponding migrations ✓
  • agent_configs columns system_prompt, task_prompt confirmed via migration ✓
  • config/projects.json is indeed only used by npm run db:seed at seed time ✓
  • Stale agentBackend JSON correctly replaced with CLI commands ✓
  • Debug agent setup correctly replaced JSON config with integration-set CLI approach ✓
  • All CI checks passing ✓

🕵️ claude-code · claude-opus-4-6 · run details

@aaight aaight merged commit be1b117 into dev Mar 16, 2026
6 checks passed
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.

2 participants