Drop the redundant body from the "Added in" admonitions - #535
Merged
Conversation
Both bodies only restated the versions already in the admonition title, so the reader got the same enumeration twice in a row. Title-only is the established form: 8 of the 14 ":::info Added in ..." admonitions in the repo already have an empty body, and Docusaurus renders them heading-only with no content div. Leaves backups.md:884 alone, whose body adds a backport to v1.33.14, v1.34.11 and v1.35.4 rather than restating its title. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BRPhcXaFRMNZWA5GAT4c3t
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| SAST | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
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.
On the DeepSeek and DigitalOcean generative pages, the
:::info Added in ...admonition restated the versions already in its own title, so the reader got the same enumeration twice in a row. This keeps the title and drops the body.Title-only is the established form — 8 of the 14
:::info Added in ...admonitions in the repo already have an empty body, and Docusaurus renders them heading-only.Leaves
backups.md:884alone: its body adds a backport tov1.33.14,v1.34.11andv1.35.4rather than restating its title.🤖 Generated with Claude Code
https://claude.ai/code/session_01BRPhcXaFRMNZWA5GAT4c3t