Skip to content

Add Documentation Unbloat workflow from Peli's Agent Factory#169

Merged
dsyme merged 2 commits intomainfrom
docs/add-unbloat-docs-workflow-aee217fd4f31d118
Feb 18, 2026
Merged

Add Documentation Unbloat workflow from Peli's Agent Factory#169
dsyme merged 2 commits intomainfrom
docs/add-unbloat-docs-workflow-aee217fd4f31d118

Conversation

@github-actions
Copy link
Contributor

Summary

This PR adds the Documentation Unbloat workflow, adapted from Peli's Agent Factory.

Source and Merge Rate

Why It's Valuable

The Documentation Unbloat workflow automatically reviews and simplifies documentation by removing verbosity while maintaining clarity and completeness. The high merge rate (85%) in the gh-aw repository demonstrates its practical value.

Key benefits:

  • Improved Readability: Concise documentation is easier to scan and understand
  • Reduced Maintenance: Shorter documentation is easier to keep up-to-date
  • Better UX: Clear, focused content reduces cognitive load
  • Continuous Improvement: Daily runs ensure documentation stays lean
  • Easy Review: One file at a time approach makes changes reviewable

What it removes:

  • Duplicate content repeated in different sections
  • Excessive bullet points that could be prose or tables
  • Redundant examples showing the same concept
  • Verbose descriptions that could be more concise
  • Repetitive "What it does" / "Why it's valuable" patterns

What it preserves:

  • Technical accuracy and specific details
  • Links to external resources
  • Code examples (though duplicates may be consolidated)
  • Critical warnings or notes

Generalization Plan

The original workflow was adapted to be language-agnostic and project-agnostic:

Removed (gh-aw specific):

  • Astro/Starlight build steps and Node.js setup
  • Playwright screenshot functionality (project-specific documentation site)
  • References to specific gh-aw directory structure (docs/src/content/docs/blog/)
  • Blog post exclusions (not universal to all repositories)
  • Documentation server lifecycle management

Kept (core value):

  • ✅ Bloat identification and removal logic
  • ✅ Protection for auto-generated files and frontmatter flags
  • ✅ Cache memory tracking to avoid re-cleaning files
  • ✅ One file per run for easy review
  • ✅ Slash command support (/unbloat) for PR-triggered runs
  • ✅ Clear success criteria (20% bloat reduction)

Made Generic:

  • File discovery patterns work with any markdown documentation
  • Exclusion patterns generalized for common file types
  • No assumptions about build tools or documentation frameworks
  • Works with any repository containing markdown files

Files Changed

  • workflows/unbloat-docs.md - Workflow specification (generalized from gh-aw)
  • docs/unbloat-docs.md - Documentation page explaining the workflow
  • README.md - Added entry in "Code Improvement Workflows" section

Complementary Workflows

This workflow pairs well with existing workflows in this repository:

  • Daily Documentation Updater - Ensures accuracy and completeness
  • Glossary Maintainer - Keeps terminology consistent
  • Link Checker - Validates all documentation links

Together, these maintain comprehensive, accurate, and readable documentation.

Proposed Name

Documentation Unbloat - Clear name describing the workflow's purpose.

Testing

After merging, you can test the workflow with:

# Manual trigger
gh aw run unbloat-docs

# Or in a PR comment
/unbloat

The workflow will run daily automatically and can also be triggered via slash command in PR comments.

AI generated by Daily Repo Goal Achiever

Add high-value workflow from Peli's Agent Factory to automatically simplify
documentation by removing verbosity while maintaining clarity.

This workflow achieved an 85% merge rate (88 merged out of 103 PRs) in the
gh-aw repository, demonstrating strong practical value.

Key features:
- Removes duplicate content and excessive bullet points
- Consolidates redundant examples and verbose descriptions
- Preserves all essential information and technical accuracy
- Works one file at a time for easy review
- Tracks cleaned files in cache memory to avoid duplication
- Supports slash command /unbloat in PR comments

Source: https://github.com/github/gh-aw/blob/v0.45.5/.github/workflows/unbloat-docs.md
Documented merge rate: 88/103 PRs merged (85%)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dsyme dsyme marked this pull request as ready for review February 18, 2026 17:30
@dsyme dsyme merged commit 52d345e into main Feb 18, 2026
1 check passed
@dsyme dsyme deleted the docs/add-unbloat-docs-workflow-aee217fd4f31d118 branch February 18, 2026 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments