Skip to content

docs: describe the AI review pipeline - #3071

Merged
marcocastignoli merged 2 commits into
ci/ai-reviewfrom
ci/ai-review-docs
Sep 30, 2026
Merged

marcocastignoli merged 2 commits into
ci/ai-reviewfrom
ci/ai-review-docs

Conversation

@marcocastignoli

Copy link
Copy Markdown
Member

The page docs/ai-review/README.md describes the AI review pipeline of #3057 as implemented so far, for readers who do not want to read much: the three steps (the gate, the information retrieval, the review) in a few lines each, with the details in expandable sections, the fourteen checks in one table, how deployments are grouped into review units (by the hash of the ABI and the verified sources of the implementation), what the model must not report, how the comment is kept safe, what a unit costs, and how to change the prompt. It links the prompt and the benchmark issue #3069.

It already describes the changes from the reviews of #3061 and #3069, which land with the hello world pull request: the pull request description and discussion in the inputs, the check other, the Markdown answer, and the two models compared. From now on the page is updated with every change to the pipeline.

The prompt docs/ai-review/REVIEW_PROMPT.md sits next to the page for now and is the same file the hello world branch reads, so the two branches merge cleanly.

🤖 Generated with Claude Code

One page for readers in a hurry: the gate, the information retrieval and the
review, each in a few lines with the details in expandable sections; the
fourteen checks in one table; how deployments are grouped into review units;
what the model must not report; how the comment is kept safe; what a unit
costs; how to change the prompt. The prompt itself sits next to it, linked
from the page, until it finds its final place.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Label error. Requires at least 1 of: documentation, specifications, descriptors, ci, tools, index. Found:

Drop the status line, the reasons behind the workflow shape, the note on
unverified deployments, the case for Markdown, the comment safety
paragraph, the prompt change procedure and the file list; every note is a
question for the reviewer. The answer's "What was reviewed" section becomes
"What could not be reviewed", present only when something limited the
review; the prompt copy follows.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@marcocastignoli
marcocastignoli marked this pull request as ready for review September 30, 2026 13:37
@marcocastignoli marcocastignoli added ci Changes to continuous integration documentation Improvements or additions to documentation labels Sep 30, 2026
@marcocastignoli
marcocastignoli merged commit 81437e3 into ci/ai-review Sep 30, 2026
6 of 7 checks passed
@marcocastignoli
marcocastignoli deleted the ci/ai-review-docs branch September 30, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Changes to continuous integration documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants