[CI] Add doc sequence check to doc quality check#764
Merged
Conversation
Add RULE 3 to the doc-quality agent prompt: within a single doc, information must be ordered so a first-time reader can follow it top-to-bottom without jumping ahead (no forward references). Includes carve-outs for roadmaps, optional "see below" pointers, backward references, cross-doc references, and conventional preamble ordering, and hands pure undefined-term cases to Rule 1. Adds the [order] tag and reworks the violation cap so one rule cannot crowd out the others.
The doc-quality check now enforces a third rule (reading order / no forward references); describe it and its carve-outs in contributing.md.
Both added cognitive load to the agent for little gain. Revert to the original "stop after 10 violations" cap and remove the Rule 1/Rule 3 delineation note.
hughperkins
changed the title
duburcqa
reviewed
Jun 26, 2026
Comment on lines
+128
to
+136
| - A brief overview / roadmap near the top that previews upcoming sections ("this guide | ||
| covers A, then B") — signposting the structure, not a dependency: the reader does not | ||
| need to understand A or B yet to keep reading. | ||
| - Optional "for more detail, see <section> below" pointers, where the current passage is | ||
| fully understandable WITHOUT following them. The test is: MUST read ahead to understand | ||
| (violation) vs more depth merely available later (fine). | ||
| - Backward references (to something earlier in the same file) are always fine. | ||
| - References to OTHER docs/files; this rule is about ordering WITHIN a single file only. | ||
| - Conventional preamble ordering (e.g. Prerequisites -> Installation -> Usage). |
Contributor
There was a problem hiding this comment.
More generally, references whatever the order should be fine in any context. It is just that reference does not count as an introduction of a concept.
Collaborator
Author
There was a problem hiding this comment.
the issue is that if the doc is like:
A foo is a bar (see [forward reference to bar]. We want to glop the bars [forward refernce to glop]. Globbing bars makes great keeyops (forward reference to keeyop)
... then the doc is unredaable I feel.
The carveout allows forward references in the narrow case that the text is still readable without reading the refrenced location.
Contributor
|
ok to merge |
…rdering Co-authored-by: Cursor <cursoragent@cursor.com> # Conflicts: # docs/source/user_guide/contributing.md
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
2 participants
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.
Issue: #
Brief Summary
copilot:summary
Walkthrough
copilot:walkthrough