Skip to content

[docs] tighten verbose step descriptions in formatting.md #38

Description

@github-actions

Condenses the two numbered step descriptions in .github/workflows/shared/formatting.md from wordy prose into tight, direct sentences — same meaning, fewer words.

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

Bloat removed:

  • Verbose "Start with..." / "Place the rest..." phrasing trimmed
  • Redundant trailing clauses eliminated ("This should give readers a quick understanding of what the report contains without needing to expand the details")

Reduction: ~35 words removed from the two step descriptions (≈25% word reduction in those lines); all essential instructions preserved.


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 32853744348 -n agent -D /tmp/agent-32853744348

# Create a new branch
git checkout -b docs/unbloat-formatting-5dd6a56bdf4059d3 main

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

# Push the branch and create the pull request
git push origin docs/unbloat-formatting-5dd6a56bdf4059d3
gh pr create --title '[docs] tighten verbose step descriptions in formatting.md' --base main --head docs/unbloat-formatting-5dd6a56bdf4059d3 --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 Aug 27, 2026, 1:35 PM UTC

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions