🗜️ Documentation Unbloat

May 8, 2026 · View on GitHub

For an overview of all available workflows, see the main README.

Review and simplify documentation by removing verbosity while maintaining clarity

The Documentation Unbloat workflow runs regularly (daily by default) to remove duplicate content, excessive bullet points, redundant examples, and verbose descriptions - while preserving all essential information, links, and technical details.

Installation

# Install the 'gh aw' extension
gh extension install github/gh-aw

# Add the workflow to your repository
gh aw add-wizard githubnext/agentics/unbloat-docs

This walks you through adding the workflow to your repository.

How It Works

graph LR
    A[Scan Documentation] --> B[Identify Verbosity]
    B --> C{Bloat Found?}
    C -->|Yes| D[Remove Redundancy]
    D --> E[Preserve Accuracy]
    E --> F[Create PR]
    C -->|No| G[Report: Docs are Lean]

The workflow improves exactly one file per run for easy review. Files with disable-agentic-editing: true in frontmatter are skipped. Uses cache memory to track previously cleaned files.

For scheduled runs, the workflow is skipped if there are already 8 or more open PRs with its title prefix, to avoid overwhelming maintainers.