Repository navigation
docs(readme-standard): keep the badge block one band with trailing group comments (issue #3353) #3391
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -75,8 +75,12 @@ never reorders them: | |
| 5. **Licence**: one badge naming every licence that applies. | ||
| 6. **Support**: sponsorship links (GitHub Sponsors, Ko-fi and the like). | ||
|
|
||
| Each group carries an HTML comment (`<!-- 2 CI/build -->`) so a reviewer can | ||
| check the order without rendering the page. The comment trails the first badge | ||
| line of its own group (the banner line for the first group) and never starts a | ||
| line of its own: a line that begins with `<!--` opens a CommonMark HTML block | ||
| that interrupts the badge paragraph, and the block then renders as one centred | ||
| row per group instead of one band. | ||
|
Comment on lines
+78
to
+83
There was a problem hiding this comment. ⚪ Low · Rendering rationale lacks evidence The new paragraph asserts that standalone comments interrupt the badge paragraph and produce separate rows but links no specification, GitHub evidence, or tracked reproducer, so readers cannot verify the documented rendering rule. Link the relevant CommonMark or GitHub rendering evidence, or add a tracked reproducer for the claim. Prompt for AI agentsIn `docs/README-STANDARD.md` at lines 78-83:
**Rendering rationale lacks evidence**
The new paragraph asserts that standalone comments interrupt the badge paragraph and produce separate rows but links no specification, GitHub evidence, or tracked reproducer, so readers cannot verify the documented rendering rule.
Link the relevant CommonMark or GitHub rendering evidence, or add a tracked reproducer for the claim.From - **C core:** rules 5 and 10 adapt to reference, rendering and diagnostic
validation. Other C-core rules apply to executable examples, not prose.
- **Additions:** `docs/`, root Markdown and [python/README.rst](../python/README.rst)
document behavior with reproducible commands and tracked evidence links.
Keep examples consistent with their implementation language; rendered
tables, equations and diagrams must remain usable without script execution. |
||
|
|
||
| Version badges for languages, toolchains, backends and integrations (C, Go, | ||
| Rust, Python, CUDA, ROCm and the like) are not part of the top block. Where | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Required: Praetor's README-01 order check reads only the first HTML comment on a line. Here that is the
README-STANDARD badge blocknote, so the1 release/versionlabel is never read, and on the Release line the first comment isx-release-please-version. On this head the check finds no group labels at all, which is why a swapped order passes.Putting the group label first fixes it without changing the rendered page:
With that change and the Tests-line move from the other comment, I ran the check again: it reads groups 1 and 2 in order, reports the planted swap, and reports nothing new on the unswapped page. The cmark output is the same as on this head. A sentence in
docs/README-STANDARD.mdsaying the group label comes before any other comment on its line would keep the next edit from undoing this.