docs: describe review module seams

This commit is contained in:
Claude
2026-09-01 01:17:00 +00:00
parent 87dd695d97
commit 8dfca67ad3
2 changed files with 8 additions and 2 deletions
+3 -1
View File
@@ -39,7 +39,9 @@ The internal seams are deliberately narrower:
- `model_client.complete()` owns the legacy Anthropic-compatible request shape. - `model_client.complete()` owns the legacy Anthropic-compatible request shape.
`opencode_review` is the preferred agent adapter and keeps Gitea I/O out of `opencode_review` is the preferred agent adapter and keeps Gitea I/O out of
the autonomous process. the autonomous process.
- `review/diff`, finding parsing, config filtering, and rendering remain - `review/analysis`, `review/output`, `review/configuration`, and
`review/adapters` keep prompt construction, finding parsing, config filtering,
rendering, and publishing in focused modules.
pure transformations. Their callers do not need to know how model or Gitea pure transformations. Their callers do not need to know how model or Gitea
transport works. transport works.
- `langfuse_trace` is an optional sink. It is fail-open and cannot change the - `langfuse_trace` is an optional sink. It is fail-open and cannot change the
+5 -1
View File
@@ -27,7 +27,11 @@ as a PR comment and does not block CI.
| `review/config.py` | Trusted base-branch opt-in policy; transport injected for tests | | `review/config.py` | Trusted base-branch opt-in policy; transport injected for tests |
| `entrypoints/gitea.py` | HTTP transport adapter and repository-scoped client | | `entrypoints/gitea.py` | HTTP transport adapter and repository-scoped client |
| `review/ai_review.py` | Small public review facade | | `review/ai_review.py` | Small public review facade |
| `review/pipeline.py` | Review orchestration and compatibility implementation | | `review/pipeline.py` | Review orchestration, runtime wiring, and compatibility symbols |
| `review/analysis.py` | Prompt construction, token attribution, and cost helpers |
| `review/output.py` | Finding parsing, anchor validation, and Markdown rendering |
| `review/configuration.py` | Repository config parsing, filtering, and prior-review context |
| `review/adapters.py` | Gitea/model transport and review publishing |
| `ai_review.py` | Compatibility shim for existing imports and CI execution | | `ai_review.py` | Compatibility shim for existing imports and CI execution |
| `review/model.py` | Anthropic-compatible model adapter and response text extraction | | `review/model.py` | Anthropic-compatible model adapter and response text extraction |
| `review/opencode.py` | Hostile-checkout containment and agent execution | | `review/opencode.py` | Hostile-checkout containment and agent execution |