Skip to content

[docs] condense WS0001 rule documentation#13

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/unbloat-WS0001-750be7c8900db136
Draft

[docs] condense WS0001 rule documentation#13
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/unbloat-WS0001-750be7c8900db136

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Reduces prose bloat in docs/rules/WS0001.md while preserving all technical information.

File improved: docs/rules/WS0001.md

Changes made:

  • Rule description: Merged three paragraphs into two. The opening paragraph now uses the shorter [LoggerMessage] reference instead of "source-generated [LoggerMessage] pattern". The net8/net9 behaviour is combined into a single sentence using "On net9.0+ ... On net8.0 ..." contrast.
  • Cause: Rewrote the 3-line prose sentence as a single line by replacing the verbose "logs through witness.Logger using one of the templated ... extension methods" with the direct "calls a templated ... extension method".
  • How to fix violations: Collapsed the two-line lead-in to one line.
  • When to suppress: Reduced the two-sentence explanation to one concise line.

Metrics:

Before After Reduction
Lines 63 50 −20.6%
Words 281 229 −18.5%

All essential information (cause pattern, performance rationale, net8 vs net9+ behaviour, fix procedure, suppression guidance) is preserved.

🗜️ Compressed by Documentation Unbloat

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/unbloat-docs.md@1c6668b751c51af8571f01204ceffb19362e0f66
  • expires on Jul 11, 2026, 3:50 PM UTC

Remove prose bloat in the Rule description and When to suppress sections:
- Merge three paragraphs into two in Rule description
- Simplify net8/net9 explanation to a single combined sentence
- Condense Cause prose to one line
- Tighten How to fix violations lead-in to one line
- Reduce When to suppress description from two lines to one

63 → 50 lines (-20.6%), 281 → 229 words (-18.5%)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants