[docs] Reduce README bloat (52 lines, -11.8%)#25
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
- Convert IWitness<T> 3-bullet list to inline prose - Condense WitnessedAction outcome bullets to one-line prose - Shorten WitnessedAction IWitness<T> facet intro sentence - Remove duplicate JSON from 'Add custom resource attributes' recipe (already shown in the appsettings.json config reference section) - Condense Analyzer section: remove duplicate 'before' code example (same pattern shown in Logging via extension methods above) and remove the full LoggerMessage pattern (documented in docs/rules/WS0001.md); add link to rule docs instead 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.md(441 → 389 lines, −52 lines / −11.8%)Types of bloat removed
1. Bullet list → inline prose (
IWitness<T>section)The three-bullet list (
ILogger<T>/Meter/ActivitySource) was converted to a single inline sentence. The follow-up explanation paragraph was tightened.2. Bullet list → prose (
WitnessedActionoutcomes)Three outcome bullets condensed to one sentence: "Outcomes are explicit: success is the default;
Failed(...)marks failure;Cancelled()marks cancellation."3. Duplicate JSON removed ("Add custom resource attributes" recipe)
The
appsettings.jsonexample in the recipe was identical to (a subset of) the JSON already shown in the Configuration reference →appsettings.jsonsection. The recipe now goes straight to the C# code, which was the only unique content.4. Analyzer section condensed (~30 lines)
[LoggerMessage]pattern example — fully documented indocs/rules/WS0001.md. Added a link instead.LoggerMessagepattern it promotes").What was preserved
WS0001install + configure severity subsections