Add Documentation Unbloat workflow from Peli's Agent Factory#169
Merged
Conversation
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>
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.
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:
What it removes:
What it preserves:
Generalization Plan
The original workflow was adapted to be language-agnostic and project-agnostic:
Removed (gh-aw specific):
docs/src/content/docs/blog/)Kept (core value):
/unbloat) for PR-triggered runsMade Generic:
Files Changed
workflows/unbloat-docs.md- Workflow specification (generalized from gh-aw)docs/unbloat-docs.md- Documentation page explaining the workflowREADME.md- Added entry in "Code Improvement Workflows" sectionComplementary Workflows
This workflow pairs well with existing workflows in this repository:
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:
The workflow will run daily automatically and can also be triggered via slash command in PR comments.