Repository navigation
docs(news): callouts for breaking changes and yanked releases - #1006
Merged
Merged
Conversation
Wrap every 💥 Breaking Changes section in a > [!WARNING] callout and give each yanked or broken release a > [!CAUTION] body naming the release to use instead, via devenv's news_normalize.py. Also point v2.3.1 at the 💥 Breaking Changes sections instead of the long-gone Upgrading notes, and normalize two sub-group labels in v1.2.4. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Converts
NEWS.mdto the callout form from devenv'snews_normalize.py(devenv #52). OnlyNEWS.mdchanges.### 💥 Breaking Changessections in a> [!WARNING]callout: v2.3.1, v2.3.0, v2.0.0, v1.11.0, v1.10.0, v1.5.0, v0.8.0 and v0.7.0. v1.11.0's nested bullets stay nested inside the box.> [!CAUTION]body that says what was wrong and which release to use instead. v0.5.8, a working version bump, gets none.- OPDS:and- Reader:lose their trailing colons), following the normalizer's existing rule.Checked locally:
make fixandmake lintpass.make docsbuild renders 8admonition warningand 8admonition cautionboxes, with no literal[!left in the page.🤖 Generated with Claude Code