docs: fix invalid since-badge placement and clarify guidance (#5713) (CP: v25.2)#5740
Merged
Merged
Conversation
Fixes `since` badges that were authored with invalid AsciiDoc and never rendered. A `since` badge is an inline role that must be immediately followed by a formatted text span (e.g. `#...#`); a span-less badge renders as literal `[since:...]` brackets or silently produces nothing. - Correct 7 broken usages across 7 articles: a badge trailing a heading (`== Title [since:...]`) and badges alone on their own line, rewritten to the span form (`== [since:...]#Title#`, or wrapping a phrase in body text). - Update the CLAUDE.md "Version References" guidance to document the correct form so future docs use it.
jouni
reviewed
Jun 25, 2026
| ```asciidoc | ||
| // Correct — on a page title or section heading: | ||
| = [since:com.vaadin:vaadin@V25.1]#Slider# | ||
| == [since:com.vaadin:vaadin@V25.2]#Hierarchical Data# |
Member
There was a problem hiding this comment.
The recommended way to annotate a section heading is to place the role/class on the heading instead of a span inside it. For example:
[role="since:com.vaadin:vaadin@V25.2"]
== Hierarchical DataThe only exception is the main/top-level heading, which doesn't allow it, so there you need to wrap it in a span.
I won't stop us from unifying everything one way or the other. But it’s not great to keep using both styles for 2nd and 3rd-level sections.
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
4 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.
No description provided.