Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ You can use the "/plan" agent to turn the reports into actionable issues which c
- [📖 Daily Documentation Updater](docs/daily-doc-updater.md) - Automatically update documentation based on recent code changes and merged PRs
- [📖 Glossary Maintainer](docs/glossary-maintainer.md) - Automatically maintain project glossary based on codebase changes
- [🔗 Link Checker](docs/link-checker.md) - Daily automated link checker that finds and fixes broken links in documentation
- [🗜️ Documentation Unbloat](docs/unbloat-docs.md) - Automatically simplify documentation by reducing verbosity while maintaining clarity
- [✨ Code Simplifier](docs/code-simplifier.md) - Automatically simplify recently modified code for improved clarity and maintainability
- [🔍 Duplicate Code Detector](docs/duplicate-code-detector.md) - Identify duplicate code patterns and suggest refactoring opportunities
- [⚡ Daily Progress](docs/daily-progress.md) - Automated daily feature development following a structured roadmap
Expand Down
178 changes: 178 additions & 0 deletions docs/unbloat-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
# 🗜️ Documentation Unbloat

> For an overview of all available workflows, see the [main README](../README.md).

The [Documentation Unbloat workflow](../workflows/unbloat-docs.md?plain=1) automatically reviews and simplifies documentation by removing verbosity while maintaining clarity and completeness.

## Installation

````bash
# 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.

You can start a run of this workflow immediately by running:

````bash
gh aw run unbloat-docs
````

Or trigger it in a pull request comment with:

````
/unbloat
````

## What It Does

The Documentation Unbloat workflow runs daily and can be triggered via `/unbloat` command in PR comments. It:

1. **Scans Documentation** - Reviews markdown files in the repository for bloat
2. **Identifies Verbosity** - Finds duplicate content, excessive bullet points, redundant examples, and verbose descriptions
3. **Removes Bloat** - Makes targeted edits to improve clarity and conciseness
4. **Preserves Accuracy** - Maintains all essential information, links, and technical details
5. **Creates Pull Requests** - Proposes documentation improvements one file at a time for easy review

## How It Works

### What Gets Removed

The workflow identifies and removes:

- **Duplicate content**: Same information repeated in different sections
- **Excessive bullet points**: Long lists that could be condensed into prose or tables
- **Redundant examples**: Multiple examples showing the same concept
- **Verbose descriptions**: Overly wordy explanations
- **Repetitive structure**: Overused "What it does" / "Why it's valuable" patterns

### What Gets Preserved

The workflow never removes:

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

### One File at a Time

The workflow improves exactly **one file per run** to keep changes small, focused, and easily reviewable. This incremental approach makes it easier to:

- Review and approve changes quickly
- Understand what was modified
- Revert changes if needed
- Track improvements over time

### Protected Files

Files can be protected from automatic editing by adding `disable-agentic-editing: true` to their frontmatter. The workflow automatically skips:

- Auto-generated documentation
- Changelog or release notes
- License or legal files
- Files marked with `disable-agentic-editing: true`

### Memory and Tracking

The workflow uses cache memory to track previously cleaned files, avoiding duplicate work and ensuring efficient coverage of documentation over time.

## Trigger Options

### Daily Schedule

Runs automatically once per day at a scattered execution time to continuously improve documentation.

### Slash Command

Trigger on-demand in pull request comments:

````
/unbloat
````

This analyzes documentation files modified in the PR and proposes improvements.

### Manual Trigger

Run manually via GitHub Actions UI or CLI:

````bash
gh aw run unbloat-docs
````

## Success Criteria

A successful run:

- ✅ Improves exactly **one** documentation file
- ✅ Reduces bloat by at least 20% (lines, words, or bullet points)
- ✅ Preserves all essential information
- ✅ Creates a clear, reviewable pull request
- ✅ Explains the improvements made

## Benefits

**Improved Readability**: Concise documentation is easier to scan and understand, helping users find information faster.

**Reduced Maintenance**: Shorter documentation is easier to keep up-to-date as the project evolves.

**Better User Experience**: Clear, focused content reduces cognitive load and improves comprehension.

**Continuous Improvement**: Daily runs ensure documentation stays lean as new content is added.

## Example Improvements

### Before (Bloated)

````markdown
### Tool Name
Description of the tool.

- **What it does**: This tool does X, Y, and Z
- **Why it's valuable**: It's valuable because A, B, and C
- **How to use**: You use it by doing steps 1, 2, 3, 4, 5
- **When to use**: Use it when you need X
- **Benefits**: Gets you benefit A, benefit B, benefit C
- **Learn more**: [Link](url)
````

### After (Concise)

````markdown
### Tool Name
Description of the tool that does X, Y, and Z to achieve A, B, and C.

Use it when you need X by following steps 1-5. [Learn more](url)
````

## Customization

You can customize the workflow by editing the [`unbloat-docs.md`](../workflows/unbloat-docs.md) file:

- Adjust which directories or file patterns to scan
- Modify the success criteria (e.g., minimum bloat reduction percentage)
- Change the PR labeling and auto-merge behavior
- Add project-specific exclusion patterns
- Customize the tone or style guidance

After making changes, recompile the workflow:

````bash
gh aw compile unbloat-docs
````

## Complementary Workflows

This workflow pairs well with:

- [Daily Documentation Updater](daily-doc-updater.md) - Ensures accuracy and completeness
- [Glossary Maintainer](glossary-maintainer.md) - Keeps terminology consistent
- [Link Checker](link-checker.md) - Validates all documentation links

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