Repository navigation
π docs: point the TechDocs assessment model at the opt-in analysis fact-check pass - #19150
Merged
Merged
Conversation
β¦ct-check pass Refs #19132 Signed-off-by: Andrew Anderson <andy@clubanderson.com>
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs #19132
Problem
The maintainer feedback in #19132 asks for another agent to do a first review of a drafted TechDocs assessment before the PR is marked ready for review. The hive already ships that as the opt-in
review.analysis_factcheckpass (#19074, merged in #19080, documented insrc/docs/review-swarm.md). The TechDocs assessment model doc never mentions it, so an operator running that workflow has no pointer to it.Change
Docs only: one new section in
src/docs/workflows/techdocs-assessment.md, "Independent fact-check before a person reviews (optional)", with a config example for acncf/techdocshive, how the pass fits the drafting / verify / ready / confirm / approve gates, and a link to the full reference. No code or config behaviour changes.Verified against
src/docs/review-swarm.mdsection onreview.analysis_factcheck: keys, defaults (off,ready_policy: human), "never applies verified", stops once a person reviews.check-api-reference-citations.sh --fixandcheck-docs-citations.py --fixboth pass with no rewrites.Not covered
Whether the pass is enabled on the TechDocs hive is operator config, not a repo change. Left to the operator, so this does not close the issue.