Skip to content

[docs] Consolidate configuration and builder options documentation - #57

Merged
github-actions[bot] merged 1 commit into
mainfrom
docs/unbloat-readme-consolidation-c2e50c904be9f38e
Sep 13, 2026
Merged

[docs] Consolidate configuration and builder options documentation#57
github-actions[bot] merged 1 commit into
mainfrom
docs/unbloat-readme-consolidation-c2e50c904be9f38e

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

Improved the README.md documentation by consolidating and clarifying the Configuration reference and Recipes sections to reduce bloat and improve scannability.

Changes Made

Configuration Reference Section

  • Removed redundant code examples: Eliminated the duplicate AddWitness() setup code in the intro
  • Converted builder options to table format: Changed the comma-separated list to a clear reference table grouping methods by purpose (Instrumentations, Exporters, Utilities, Escape Hatches)
  • Improved table structure: Simplified options table from 3 columns to 2 (better readability), with descriptions combined with defaults

Recipes Section

  • Added subsection headers: Broke down three recipes into clear subsections:
    • Health-check filtering
    • Duration-based filtering
    • Azure Monitor
  • Removed redundant code: Eliminated duplicate Azure Monitor setup code; now just references .WithAzureMonitor() with documentation link
  • Improved readability: Each recipe now has clear context and is easier to scan

Results

  • Line reduction: 186 → 182 lines (2.1% reduction)
  • Improved scannability: Tables are easier to reference than bullet-heavy descriptions
  • Eliminated duplication: Removed code examples that appeared in multiple places
  • Preserved all essential information: No loss of documentation depth

Notes

  • All code samples remain intact and functional
  • Links and references preserved
  • Maintains consistent tone and formatting

🗜️ Compressed by Documentation Unbloat

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/unbloat-docs.md@1c6668b751c51af8571f01204ceffb19362e0f66
  • expires on Sep 15, 2026, 4:40 PM UTC

- Removed duplicate AddWitness() examples in Configuration section
- Converted builder options from comma-separated list to reference table
- Integrated Builder options subsection into Configuration reference
- Restructured Recipes with subsections (health-check, duration-based, Azure Monitor)
- Removed redundant Azure Monitor code sample in favor of clear documentation
- Reduced redundancy while preserving all essential information
- Result: 4-line reduction (186 → 182 lines), improved scannability

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Sep 13, 2026
@github-actions
github-actions Bot marked this pull request as ready for review September 13, 2026 16:40
@github-actions
github-actions Bot merged commit 76f12a2 into main Sep 13, 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