docs: update README and CLAUDE.md with complete feature documentation#27
Merged
Conversation
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>
| ## Architecture | ||
|
|
||
| Two entry points trigger the same review pipeline: | ||
| Three entry points: |
There was a problem hiding this comment.
🟡 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>
Owner
Author
|
/canon review |
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>
Owner
Author
|
/canon review |
Co-authored-by: canon-review[bot] <263756372+canon-review[bot]@users.noreply.github.com>
Owner
Author
|
/canon review |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
/canon init,/canon index,/canon reset) that were missing from READMEMAX_REVIEW_ROUNDS,MAX_REPO_FILES,MAX_PROMPT_TOKENS,RETRY_MAX_ATTEMPTS,RETRY_BASE_DELAY_MS,EMBEDDING_DIMENSIONS)PRIVATE_KEYvsPRIVATE_KEY_PATH)review-counts.ts,content-cache.ts,openai-models.ts,openai-runner.ts,retry.ts,init-handler.ts,push-handler.ts)/canon resetcommandTest plan
src/config/index.tssrc/github/comment-handler.tssrc/directorynpm testto confirm test count matches (292)🤖 Generated with Claude Code