Skip to main content

Walkthrough anatomy

The walkthrough is the top-level review comment Qodex posts on a pull request. It helps the author understand what changed, what Qodex checked, which findings were raised, and whether any findings could not be attached inline.

What the walkthrough contains

The walkthrough is posted as a GitHub review comment. It usually contains four parts:
  • A header summary.
  • An optional “Findings outside the diff” section.
  • A collapsible “What Qodex checked” block.
  • A footer with model, timing, and filtering details.
Inline findings are attached to the same GitHub review, but they render next to the changed code instead of inside the walkthrough body.

Header summary

The header gives a short behavior-level summary of the PR. It explains what Qodex thinks the diff changes, then shows an effort score and finding counts grouped by severity.
When Qodex finds nothing worth raising, the walkthrough says the diff reads clean. An empty findings list is a valid review outcome. On non-trivial diffs, Qodex may take one deeper look before it accepts a clean result. If that zero-finding escalation pass runs, the walkthrough’s checklist calls it out so the author can see that Qodex specifically rechecked for subtle consistency, contract, and missing-predicate issues.

Findings outside the diff

GitHub only accepts inline review comments on lines that are part of the PR diff. If Qodex finds something related but the cited line is outside the diff, the finding appears in the walkthrough instead.
This keeps useful context visible without pretending GitHub accepted it as an inline finding.

”What Qodex checked” block

The walkthrough includes a collapsible <details> block that shows what Qodex actually ran. Checked boxes mean a step ran. Empty boxes mean the step was skipped, usually with a reason. The block covers four areas:
  1. Lenses: bugs, security, performance, maintainability, and style.
  2. Quality filters: the confidence floor, severity threshold, and path excludes.
  3. Verification probes: whether a preview deployment was found and whether probes ran.
  4. Output: whether the walkthrough and inline comments were posted.
The footer shows the model, elapsed time, and a truncation note when the diff was capped at 200 KB.

A complete sample

When the walkthrough updates

Each review run posts a fresh review and walkthrough comment. The Check Run on the same head SHA updates in place, so the PR checks panel does not stack duplicate checks.

On the roadmap

A resolution affordance is on the roadmap. When a reviewer comments @qodex resolve <finding-id> or @qodex false-positive <finding-id> on an inline finding, Qodex will record the signal and train the per-project filter so the same noise stops recurring on future PRs.

Inline findings

Verification probes

Check Run and merge gating

.qodex.yaml reference