[docs] Improve Builder Options Section Readability - #56
Merged
Conversation
- Replace bullet points with prose + em-dash formatting for clearer scanning
- Condense verbose phrases ('for common scenarios' removed from descriptions)
- Streamline escape-hatch description ('for direct OTel builder access')
- Simplify warning line by using 'convenience and escape-hatch' pattern
- Better visual hierarchy through strategic line breaks
- Reduced character count from 549 to 542 (1.3% reduction)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
automation
documentation
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.
Summary
Streamlined the "Builder options" section in README.md for improved clarity and scannability.
Changes Made
Impact
Testing
This is a targeted improvement focusing on one key section that had dense method listings.