docs: audit and fix README, getting-started, and CLAUDE.md accuracy#916
Merged
docs: audit and fix README, getting-started, and CLAUDE.md accuracy#916
Conversation
nhopeatall
reviewed
Mar 16, 2026
Collaborator
nhopeatall
left a comment
There was a problem hiding this comment.
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 insrc/config/schema.tsPROJECT_DEFAULTS) - ✅
statusesis the correct field name (notstatusMap) inJiraConfigSchema - ✅
agentBackendhas zero remaining references insrc/ - ✅ 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.tsexists,--engineflag exists onagents create - ✅ All new
projects updateflags (--work-item-budget,--watchdog-timeout,--progress-model,--progress-interval,--run-links-enabled,--max-in-flight-items) confirmed insrc/cli/dashboard/projects/update.ts - ✅ Vite dev server proxies to
:3001(confirmed inweb/vite.config.ts) - ✅
config/projects.jsonis only used bynpm run db:seed(viatools/seed-config-from-json.ts) - ✅
agent_configscolumnssystem_promptandtask_promptconfirmed in schema - ✅
projectscolumnssquint_db_url,run_links_enabled,max_in_flight_itemsconfirmed 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 actualsrc/cli/dashboard/runs/directory also contains 9.tsfiles. 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>
Collaborator
Author
|
Fixed! Corrected 🕵️ claude-code · claude-sonnet-4-6 · run details |
nhopeatall
approved these changes
Mar 16, 2026
Collaborator
nhopeatall
left a comment
There was a problem hiding this comment.
LGTM — thorough documentation audit with every factual claim verified against source code.
Verified against codebase:
PROJECT_DEFAULTS.agentEngine === 'llmist'insrc/config/schema.ts✓JiraConfigSchemausesstatuses(notstatusMap) ✓- Vite proxy targets port 3001, dashboard defaults to 3001 ✓
npm run devrunssrc/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 updateflags (--work-item-budget,--watchdog-timeout,--progress-model,--progress-interval,--run-links-enabled,--max-in-flight-items) exist ✓ --engineflag onagents createconfirmed ✓- All referenced DB tables (
agent_definitions,prompt_partials,pr_work_items,webhook_logs,agent_trigger_configs) have corresponding migrations ✓ agent_configscolumnssystem_prompt,task_promptconfirmed via migration ✓config/projects.jsonis indeed only used bynpm run db:seedat seed time ✓- Stale
agentBackendJSON correctly replaced with CLI commands ✓ - Debug agent setup correctly replaced JSON config with
integration-setCLI approach ✓ - All CI checks passing ✓
🕵️ claude-code · claude-opus-4-6 · run details
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Audits and fixes documentation inaccuracies across
README.md,docs/getting-started.md, andCLAUDE.mdto reflect recent codebase changes.getting-started.mdincorrectly listed Claude Code as the default engine; actual default isllmist(persrc/config/schema.tsPROJECT_DEFAULTS). Engine table reordered and LLMist credential section added first.statusMap→statusesto matchJiraConfigSchemainsrc/config/schema.tsagentBackendJSON removed from CLAUDE.md — replaced with correct CLI approach (cascade projects update --agent-engineandcascade agents create --engine)agent_definitions,prompt_partials,pr_work_items,webhook_logs,agent_trigger_configsto schema section; updatedagent_configsandprojectsdescriptions with new columnsruns cancel,definitions(9 cmds),prompts(8 cmds),webhooklogs(2 cmds), plus missingprojects updateflags (--work-item-budget,--watchdog-timeout,--progress-model,--progress-interval,--run-links-enabled,--max-in-flight-items) and--engineflag foragents createagent_configsrequirementconfig/projects.jsonJSON snippet; replaced with CLIintegration-setapproachCLAUDE_CODE_OAUTH_TOKEN"backend" → "engine",Codex Backend→Codex Enginesection heading,Claude Code Backend→Claude Code Enginesection heading,npm run devcomment clarified to say Router not Dashboard, CLI directory tree updated with new command groupsllmist(default) firstTest plan
agentBackend,statusMap,claude-code.*default,Supabase transaction pooler,Claude Code backendnode bin/cascade.js --helpoutput matches documented commandsJiraConfigSchemainsrc/config/schema.tsusesstatusesnotstatusMapPROJECT_DEFAULTS.agentEngine === 'llmist'insrc/config/schema.tsTrello 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