31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
# PR#165: The AI review reports nothing about generated sections of the docs
|
|
|
|
> **WARNING:** This document describes only the change applied in this PR.
|
|
> It may already be outdated once the next PR is merged.
|
|
> Historic PR-documentation is not maintained along with new PRs — treat it as a snapshot, not as current documentation.
|
|
|
|
## Related Links
|
|
|
|
- [werkrevisor PR#122](https://git.javagil.de/mi/werkrevisor/pulls/122): werkrevisor 0.49.1 skips generated sections.
|
|
|
|
## Problem
|
|
|
|
A tool can write a section of a doc, from a comment `<!-- generated by … -->` up to the next heading,
|
|
e.g. `tools/generate-verified-by` of hsadmin-ng.
|
|
Such a section holds long links, and nobody can change it by hand.
|
|
Since werkrevisor 0.49.1 its writing rules skip such a section, and its own config tells the model and Codex to do the same.
|
|
The review instructions of werkator come from its `.werkrevisor.toml`, which lacks this hint.
|
|
|
|
## Non-Goals
|
|
|
|
- No generated section in werkator itself; the hint keeps the instructions the same in all werk repositories.
|
|
|
|
## Solution
|
|
|
|
- `.werkrevisor.toml`: the review instructions tell the model to report nothing about a generated section.
|
|
- Version 1.43.5 with an internal release-notes entry.
|
|
|
|
## Additional Changes
|
|
|
|
None.
|