Skip to content

docs: update README and CLAUDE.md with complete feature documentation#27

Merged
SimonOyaneder merged 5 commits into
mainfrom
docs/update-readme-and-claude-md
Feb 25, 2026
Merged

docs: update README and CLAUDE.md with complete feature documentation#27
SimonOyaneder merged 5 commits into
mainfrom
docs/update-readme-and-claude-md

Conversation

@SimonOyaneder

Copy link
Copy Markdown
Owner

Summary

  • Update test count from 101 to 292 (26 suites) to reflect current state
  • Document all comment commands (/canon init, /canon index, /canon reset) that were missing from README
  • Add missing environment variables to the README table (MAX_REVIEW_ROUNDS, MAX_REPO_FILES, MAX_PROMPT_TOKENS, RETRY_MAX_ATTEMPTS, RETRY_BASE_DELAY_MS, EMBEDDING_DIMENSIONS)
  • Document push event handler for incremental indexing
  • Add Docker Compose setup instructions and production deployment notes (PRIVATE_KEY vs PRIVATE_KEY_PATH)
  • Document integration tests with testcontainers
  • Update architecture diagram to include push events
  • Update file structure to include all files (review-counts.ts, content-cache.ts, openai-models.ts, openai-runner.ts, retry.ts, init-handler.ts, push-handler.ts)
  • Update CLAUDE.md with push handler, retry logic, review rounds, content cache, and /canon reset command

Test plan

  • Verify all documented env vars match src/config/index.ts
  • Verify all documented commands match src/github/comment-handler.ts
  • Verify file structure matches actual src/ directory
  • Run npm test to confirm test count matches (292)

🤖 Generated with Claude Code

Update test count (101 → 292), document all commands (/canon init, /canon index,
/canon reset), add missing env vars, document push handler, Docker setup,
integration tests, retry logic, review rounds, and content caching.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

@canon-review canon-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Found 1 pattern deviations: 🟡 1 medium

Comment thread CLAUDE.md Outdated
## Architecture

Two entry points trigger the same review pipeline:
Three entry points:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Pattern Violation · medium · confidence: 99%

Section says "Three entry points" but lists six triggers, which breaks the repository’s documentation consistency pattern of accurate event summaries.

Existing pattern: Event summaries match the actual routed handlers and enumerate all trigger types accurately.
Reference: src/index.ts

Suggested change
Three entry points:
Three event types (with multiple commands on issue comments):

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@SimonOyaneder

Copy link
Copy Markdown
Owner Author

/canon review

@canon-review canon-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Reviewed this PR and found no pattern deviations. The code follows existing repository conventions. ✅

Remove pull_request.synchronize handler so Canon only reviews automatically
when a PR is opened. Subsequent reviews require manual trigger via
/canon review or @canon.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@SimonOyaneder

Copy link
Copy Markdown
Owner Author

/canon review

@canon-review canon-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Found 1 pattern deviations: ⚪ 1 low

Comment thread src/index.ts Outdated
Co-authored-by: canon-review[bot] <263756372+canon-review[bot]@users.noreply.github.com>
@SimonOyaneder

Copy link
Copy Markdown
Owner Author

/canon review

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@SimonOyaneder SimonOyaneder merged commit f3fea4a into main Feb 25, 2026
2 checks passed
@SimonOyaneder SimonOyaneder deleted the docs/update-readme-and-claude-md branch February 25, 2026 22:36
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.

1 participant