Add tips about escape characters in changelog docs#2670
Merged
Conversation
🔍 Preview links for changed docs |
cotti
approved these changes
Feb 10, 2026
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
2 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.
This PR updates the docs for the
docs-builder changelog addcommand to make it clearer that escape characters are required if you're using special characters (specifically in the options that contain a lot of text).I've also made the following unrelated changes to the docs:
-houtput snippets from the changelog docs, since I think it's better to refer folks to the CLI docs and/or have them run the help option themselves.changelog.mdcontribution doc to the appropriate CLI command page, since IMO the former should be a higher-level overview of the workflow.