Add :highlights: and keep-highlight-descriptions to changelog directive - #3803
Merged
Conversation
2 tasks
Mpdreamz
approved these changes
Aug 6, 2026
lcawl
enabled auto-merge (squash)
August 7, 2026 12:57
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.
Goal
Highlights are a boolean flag (
highlight: true), not an entry type.The changelog directive should stop treating them as a
:type:value.This PR enables authors to put a "Highlights" section on any page that uses the directive (and optionally show their full descriptions even when none of the other sections show them)
Implementation details
:highlights:option for the changelog directive:description-visibility: keep-highlight-descriptionsoptionhighlightsvalue from the:type:optionCode
:highlights:boolean onChangelogBlockviaPropBool("highlights"), threaded throughChangelogRenderOptionsChangelogTypeFilter.Highlight; legacy:type: highlightwarns and falls back to DefaultHighlightsEnabled(not:type: all); TOC/anchors updated to match:description-visibility: keep-highlight-descriptions::highlights:, hides descriptions everywhereDocs / fixtures
docs/syntax/changelog.mdanddocs/data/release-notes/publish.mddocs-testsrelease-notes pages now use:highlights:Tests
ChangelogHighlightsOptionTests.csScreenshots
When I add a directive like this in the Cloud Serverless release notes page:
:::{changelog} :cdn: cloud-serverless :highlights: :description-visibility: keep-highlight-descriptions :link-visibility: keep-links :::The rendered page contains highlight sections like this:
And another:
Generative AI disclosure
Tool(s) and model(s) used: Cursor Grok 4.5