[docs] Remove bloat from README#22
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
- Convert IWitness<T> and WitnessedAction bullet lists to inline prose - Remove duplicate 'Add custom resource attributes' recipe (fully covered by Configuration Reference) - Fold analyzer install/editorconfig subsections into description paragraph 440 → 390 lines (-50 lines); bullet points reduced 10 → 4 (60%) 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.
What was improved
File:
README.mdBloat removed
Converted bullet lists to prose — The
IWitness<T>intro (3-item list) andWitnessedActionoutcomes (3-item list) were converted to concise inline prose, saving 10 lines and eliminating 6 bullet points.Removed duplicate recipe — The "Add custom resource attributes"
<details>recipe (31 lines) was fully covered by the Configuration Reference section already above it. Both the JSON form and the code form it showed are present in the reference. Removing it avoids sending readers to a recipe for content they just read.Folded analyzer subsections — The
### Install the analyzerand### Configure severitysubsections were combined into a single sentence + code block, saving ~5 lines and reducing subsection noise.Metrics
All essential information is preserved: installation commands, configuration options, recipes, testing guidance, and links.