Skip to content

[docs] Unbloat project-tracking.md for improved clarity #14399

@github-actions

Description

@github-actions

Summary

Reduced documentation bloat in project-tracking.md while preserving all essential information:

  • 41% line reduction: 328 → 193 lines
  • 60% bullet point reduction: 72 → 29 bullets

Changes Made

  1. Consolidated duplicate configuration - Removed repetitive YAML examples that showed the same information
  2. Converted verbose troubleshooting - Transformed bullet-style troubleshooting into a concise comparison table
  3. Removed redundant sections - Eliminated "Safe Output Operations" section that duplicated earlier configuration content
  4. Streamlined best practices - Condensed 6 bullet points into 2 sentences
  5. Simplified prerequisites - Reduced detailed nested lists to 3 numbered items with links for details
  6. Condensed cross-references - Simplified "See Also" section from 6 bullets to 1 line

Technical Note: Screenshots

Screenshot capture was attempted but failed due to Playwright network isolation preventing localhost access (net::ERR_CONNECTION_REFUSED). The documentation server was running and responding to curl requests on `(localhost/redacted) but Playwright's sandboxed environment could not connect.

Testing

  • ✅ Verified all essential information preserved
  • ✅ Reduced file size by 41% (135 lines removed)
  • ✅ Maintained all code examples and configuration details
  • ✅ Preserved all critical links to reference documentation

References:

AI generated by Documentation Unbloat

  • expires on Feb 9, 2026, 5:37 PM UTC

Note

This was originally intended as a pull request, but the git push operation failed.

Workflow Run: View run details and download patch artifact

The patch file is available in the agent-artifacts artifact in the workflow run linked above.

To apply the patch locally:

# Download the artifact from the workflow run https://github.com/github/gh-aw/actions/runs/21784022073
# (Use GitHub MCP tools if gh CLI is not available)
gh run download 21784022073 -n agent-artifacts

# The patch file will be at agent-artifacts/tmp/gh-aw/aw.patch after download
# Apply the patch
git am agent-artifacts/tmp/gh-aw/aw.patch
Show patch preview (239 of 239 lines)
From 3382ed35245e5a86f3ffe19a527314e845dcf0f0 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Sat, 7 Feb 2026 17:34:31 +0000
Subject: [PATCH] docs: unbloat project-tracking.md for improved clarity
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Reduced documentation bloat while preserving all essential information:
- Consolidated duplicate configuration examples
- Converted verbose troubleshooting bullets into a concise table
- Removed redundant "Safe Output Operations" section
- Streamlined best practices from 6 bullets to 2 sentences
- Condensed prerequisites from detailed lists to 3 numbered items
- Simplified "See Also" section

Results: 328 → 193 lines (41% reduction), 72 → 29 bullets (60% reduction)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
---
 .../content/docs/examples/project-tracking.md | 175 ++----------------
 1 file changed, 20 insertions(+), 155 deletions(-)

diff --git a/docs/src/content/docs/examples/project-tracking.md b/docs/src/content/docs/examples/project-tracking.md
index c073a10..157b815 100644
--- a/docs/src/content/docs/examples/project-tracking.md
+++ b/docs/src/content/docs/examples/project-tracking.md
@@ -28,85 +28,22 @@ safe-outputs:
 ---

-This enables:
-- update-project - Add items to projects, update fields (status, priority, etc.)
-- create-project-status-update - Post status updates to project boards

-## Configuration

-### Update Project Configuration

-Configure update-project in the safe-outputs section:

-```yaml
-safe-outputs:

  • update-project:
  • project: https://github.com/orgs/github/projects/123 # Default project URL
  • max: 20 # Max operations per run (default: 10)
  • github-token: ${{ secrets.GH_AW_PROJECT_GITHUB_TOKEN }}
  • views: # Optional: auto-create views
  •  - name: "Spr
    

... (truncated)


</details>

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions