[docs] docs: reduce README bloat — condense bullets, remove duplicate recipe#20
Draft
github-actions[bot] wants to merge 1 commit into
Draft
[docs] docs: reduce README bloat — condense bullets, remove duplicate recipe#20github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
- Condense IWitness<T> bullet list to inline prose - Condense WitnessedAction outcome bullets to single sentence - Condense design philosophy bullets to inline prose - Remove 'Add custom resource attributes' recipe (duplicates configuration reference section) - Fold WS0001 install/severity subsections into prose 440 → 385 lines (55 lines removed, ~12.5% 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.
Improves
README.mdby removing duplicated content and converting bullet-heavy sections to concise prose.Changes
File:
README.md— 440 → 385 lines (55 lines removed, ~12.5% reduction)Bloat removed
<details>recipe — both its JSON snippet and code snippet are already shown in the Configuration reference sectionIWitness<T>section: 3-bullet list + 2 explanatory sentences condensed to one sentenceWitnessedActionoutcomes: 3-bullet list condensed to a single inline sentenceContent preserved
All essential information is retained — the removed recipe's content is already covered by the Configuration reference section directly above it. Links, code examples, and technical details are unchanged.