Skip to content

docs: add how-it-works, review profiles, Docker and CI tips - #6

Merged
ngoyal16 merged 1 commit into
mainfrom
docs/page-improvements
Nov 19, 2026
Merged

ngoyal16 merged 1 commit into
mainfrom
docs/page-improvements

Conversation

@ngoyal16

@ngoyal16 ngoyal16 commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Description

Improves the GitHub Pages site and README with the useful parts of the retired code-reviewer-ai-agent docs, rewritten to describe only what this bot does (no AST slicing, auto-approve or Bitbucket Data Center claims).

  • How it works: an 8-step pipeline on the page (new #how section and nav link) and a 7-step diagram in the README.
  • Review profiles: what chill, balanced and assertive report, taken from internal/review/prompts.go.
  • Docker: docker run examples for a PR URL and for --local, with release-please version markers.
  • CI tips: allow_failure: true in the GitLab example on the page, draft/closed/already-reviewed skipping with --auto, self-managed GitLab with a private CA (SSL_CERT_FILE, or skip_tls_verify as a last resort), --fail-on gating.
  • README: Contributing section (CONTRIBUTING, Code of Conduct, SECURITY).
  • ROADMAP: removed "Two-pass verification", which already ships as review.verify.

Type of Change

  • feat: New feature or capability
  • fix: Bug fix or patch
  • docs: Documentation update
  • refactor: Code refactoring without behavioral changes
  • test: Adding or improving tests
  • chore: Build, CI/CD, dependency, or tooling change

Checklist

  • My PR title follows the Conventional Commits format (e.g. feat(scope): short description)
  • I have executed local unit tests and code formatting (make test, make fmt, make lint)
  • I have updated relevant documentation / README.md if necessary
  • I have maintained all existing safety and dry-run guarantees

Docs only, no Go changes: make test passes (make fmt/make lint not run), and the page was checked in headless Chrome.

🤖 Generated with Claude Code

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>
@CLAassistant

CLAassistant commented Nov 19, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@ngoyal16
ngoyal16 merged commit 3cb523e into main Nov 19, 2026
13 checks passed
@ngoyal16
ngoyal16 deleted the docs/page-improvements branch November 19, 2026 17:46
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.

2 participants