Skip to content

docs: streamline CLAUDE.md — fix stale info, add missing engines/integrations, reduce duplication#1009

Merged
zbigniewsobiecki merged 1 commit intodevfrom
chore/streamline-claude-md
Mar 23, 2026
Merged

docs: streamline CLAUDE.md — fix stale info, add missing engines/integrations, reduce duplication#1009
zbigniewsobiecki merged 1 commit intodevfrom
chore/streamline-claude-md

Conversation

@aaight
Copy link
Copy Markdown
Collaborator

@aaight aaight commented Mar 23, 2026

Summary

Streamlines CLAUDE.md from 772 lines to 688 lines while fixing 10+ stale/inaccurate claims and documenting previously undocumented features.

Accuracy fixes:

  • Fix title from "Trello-to-Code" to "PM-to-Code" (matches package.json description)
  • Fix Architecture trigger pipeline to include JIRA/Sentry/GitHub sources
  • Fix Architecture to list all agent types: alerting, backlog-manager, resolve-conflicts
  • Fix Schema project_integrations: categories are pm/scm (not pm/scm/email), providers are trello/jira/github (not imap/gmail)
  • Add missing agent_engine_settings column to agent_configs schema entry
  • Fix Context Compaction: all agents use unified 80%/50%/5 config (was incorrectly claiming per-agent 70%/40%/8 for implementation)
  • Fix npm start: runs the router (dist/router/index.js), NOT dashboard+frontend
  • Fix cascade-tools binary description: discovers all non-dashboard CLI commands (not just pm/scm/session)
  • Update Dual-Persona agent list from personas.ts: implementer now includes debug, alerting, backlog-manager, resolve-conflicts
  • Replace stale email:received trigger with alerting:* triggers

New documentation:

  • Add OpenCode engine section (src/backends/opencode/)
  • Add Sentry/Alerting integration section with all relevant paths
  • Add src/jira/, src/sentry/, src/cli/alerting/ to Key Directories

Streamlining:

  • Remove 45-line manual Table of Contents (GitHub auto-generates; gets stale)
  • Collapse 140-line CLI command listing into <details> block
  • Remove duplicate Credentials subsection (merged into Credential Encryption section)
  • Condense Webhook Signature Verification from ~25 to ~12 lines
  • Consolidate trigger CLI examples (Review + PM sections trimmed)
  • Slim User Management (moved out of Dashboard section, removed duplicate inline DB fallback)

Test plan

  • Verify all file paths mentioned exist in the repo
  • Verify npm start command via package.json
  • Verify compaction config via src/config/compactionConfig.ts
  • Verify integration categories/providers via src/db/schema/integrations.ts
  • Verify agent_engine_settings column via src/db/schema/agentConfigs.ts
  • Verify persona agent map via src/github/personas.ts
  • Verify opencode backend exists at src/backends/opencode/
  • Verify sentry directories exist: src/sentry/, src/triggers/sentry/, src/gadgets/sentry/, src/cli/alerting/
  • Verify cascade-tools glob pattern via bin/cascade-tools.js

Card: https://trello.com/c/uaclX41D/527-lets-streamline-claudemd-so-its-not-this-long-and-triple-check-and-spot-check-to-make-sure-info-therein-are-up-to-date

🤖 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

LGTM — solid documentation streamlining that reduces CLAUDE.md by ~11% while fixing genuinely stale information and adding previously undocumented features (OpenCode engine, Sentry/Alerting integration).

I verified the key factual claims against source code:

  • npm startpackage.json confirms "start": "node dist/router/index.js" (router, not dashboard). Fix is correct.
  • Compaction configsrc/config/compactionConfig.ts confirms a single unified config: 80%/50%/5 for all agents. Fix is correct.
  • project_integrations schemasrc/db/schema/integrations.ts confirms categories are pm/scm and providers are trello/jira/github. Fix is correct.
  • agent_engine_settings columnsrc/db/schema/agentConfigs.ts confirms the agentEngineSettings column exists. Addition is correct.
  • cascade-tools globbin/cascade-tools.js confirms the glob ['**/*.js', '!**/dashboard/**', ...] which discovers all non-dashboard CLI commands (including alerting/). Fix is correct.
  • Dual-persona agentssrc/github/personas.ts explicitly maps debug to implementer; alerting, backlog-manager, resolve-conflicts resolve to implementer via the default fallback (?? 'implementer'). The CLAUDE.md listing is functionally correct.
  • New paths → Verified src/backends/opencode/, src/sentry/, src/triggers/sentry/, src/gadgets/sentry/, src/cli/alerting/, src/jira/, src/agents/definitions/alerting.yaml all exist.
  • package.json description → Confirms "AI-powered PM-to-Code automation platform", matching the title fix.

The structural changes (ToC removal, <details> collapse, section consolidation) are sensible — they reduce maintenance burden without losing discoverability. All CI checks pass.

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

@zbigniewsobiecki zbigniewsobiecki merged commit f73ad65 into dev Mar 23, 2026
9 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.

3 participants