Add documentation unbloat workflow for automated cleanup#1464
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
.github/workflows/unbloat-docs.md
Outdated
| create-pull-request: | ||
| title-prefix: "[docs] " | ||
| labels: [documentation, automation] | ||
| draft: false |
There was a problem hiding this comment.
Changed to draft: true in commit 20e2ecb
|
|
||
| ### 1. Find Documentation Files | ||
|
|
||
| Scan the `docs/` directory for markdown files: |
There was a problem hiding this comment.
@copilot update prompt to look at the list of modified docs file in the current branch, if in a PR. Use template region to conditionally insert the text
There was a problem hiding this comment.
Added conditional template region that detects PR context and prioritizes reviewing modified docs files in the current PR. The section uses {{#if ${{ github.event.pull_request.number }}}} to conditionally show instructions for getting changed files from the PR. See commit 20e2ecb
|
|
||
| **Standardize structure**: | ||
| - Reduce repetitive "What it does" / "Why it's valuable" patterns | ||
| - Use varied, natural language |
There was a problem hiding this comment.
@copilot add section on simplifying code sample:
remove complexity from samples unless necessary.
There was a problem hiding this comment.
Added "Simplify code samples" section with guidance on removing unnecessary complexity from examples. See commit 20e2ecb
…ification Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
Agentic Changeset Generator triggered by this pull request |
This PR adds a new agentic workflow that automatically scans and cleans up documentation bloat in the
docs/directory.What This Workflow Does
The
unbloat-docsworkflow uses Claude to identify and remove documentation bloat while preserving all essential information. It focuses on:Workflow Behavior
The workflow is designed to make small, surgical changes:
docs/directoryTriggers
/unbloatcommand in PR commentsExample Improvement
Before (Bloated):
After (Concise):
### 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.Safety Features
safe-outputsfor secure PR creationFiles Changed
.github/workflows/unbloat-docs.md- Workflow definition.github/workflows/unbloat-docs.lock.yml- Compiled GitHub Actions YAMLThe workflow is ready to help maintain clean, concise documentation automatically! 📝✨
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.