Repository navigation
docs: add how-it-works, review profiles, Docker and CI tips - #6
Merged
Merged
Conversation
Ideas carried over from the retired code-reviewer-ai-agent docs, rewritten to match what this bot actually does: - "How it works" pipeline on the page and in the README - review profiles (chill, balanced, assertive) explained - Docker run examples (PR URL and --local) - CI tips: allow_failure, draft skipping, self-managed GitLab with a private CA or skip_tls_verify, --fail-on gating - Contributing / Code of Conduct / Security links in the README - drop "Two-pass verification" from ROADMAP: it ships as review.verify Co-Authored-By: Claude Opus 5.5 <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.
Description
Improves the GitHub Pages site and README with the useful parts of the retired
code-reviewer-ai-agentdocs, rewritten to describe only what this bot does (no AST slicing, auto-approve or Bitbucket Data Center claims).#howsection and nav link) and a 7-step diagram in the README.chill,balancedandassertivereport, taken frominternal/review/prompts.go.docker runexamples for a PR URL and for--local, with release-please version markers.allow_failure: truein the GitLab example on the page, draft/closed/already-reviewed skipping with--auto, self-managed GitLab with a private CA (SSL_CERT_FILE, orskip_tls_verifyas a last resort),--fail-ongating.review.verify.Type of Change
feat:New feature or capabilityfix:Bug fix or patchdocs:Documentation updaterefactor:Code refactoring without behavioral changestest:Adding or improving testschore:Build, CI/CD, dependency, or tooling changeChecklist
feat(scope): short description)make test,make fmt,make lint)README.mdif necessaryDocs only, no Go changes:
make testpasses (make fmt/make lintnot run), and the page was checked in headless Chrome.🤖 Generated with Claude Code