Skip to content

[docs] condense formatting.md descriptions (~38% prose reduction) #19

Description

@github-actions

Tightened the verbose item descriptions in .github/workflows/shared/formatting.md.

File improved: .github/workflows/shared/formatting.md

Bloat removed:

  • Verbose descriptions in numbered list items: condensed multi-clause sentences to direct, single-line descriptions
  • Filler phrases in Footer Attribution: removed "to your comment" and "after your content"

Metrics:

  • Prose word count: ~122 words → ~75 words (~38% reduction)
  • Line count: unchanged (39 lines) — cuts were within existing lines, no structural rewrite

All essential content preserved: the two-step structure (overview + details), the <b> tag requirement, the example code block, and the footer prohibition are all intact.


Warning

Protected Files — Push Permission Denied

This was originally intended as a pull request, but the patch modifies protected files. A human must create the pull request manually.

Protected files

The push was rejected because GitHub Actions does not have workflows permission to push these changes, and is never allowed to make such changes, or other authorization being used does not have this permission.

Create the pull request manually
# Download the patch from the workflow run
gh run download 29423322736 -n agent -D /tmp/agent-29423322736

# Create a new branch
git checkout -b docs/unbloat-formatting-0cf635608a7a6dd2 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-29423322736/aw-docs-unbloat-formatting.patch

# Push the branch and create the pull request
git push origin docs/unbloat-formatting-0cf635608a7a6dd2
gh pr create --title '[docs] condense formatting.md descriptions (~38% prose reduction)' --base main --head docs/unbloat-formatting-0cf635608a7a6dd2 --repo droosma/WitnessSharp

🗜️ Compressed by Documentation Unbloat

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/unbloat-docs.md@1c6668b751c51af8571f01204ceffb19362e0f66
  • expires on Jul 17, 2026, 2:27 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions