Skip to content

[docs] Unbloat: examples/project-tracking.md (-21%)#29243

Merged
pelikhan merged 1 commit intomainfrom
docs/unbloat-project-tracking-94cd6334241e1b77
Apr 30, 2026
Merged

[docs] Unbloat: examples/project-tracking.md (-21%)#29243
pelikhan merged 1 commit intomainfrom
docs/unbloat-project-tracking-94cd6334241e1b77

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Reduces docs/src/content/docs/examples/project-tracking.md from 255 → 202 lines (−53 lines, −20.8%) by removing five categories of bloat while preserving all essential technical content.

Changes made

Category Lines removed
Redundant "This enables:" bullet list (already implied by YAML comments and next section) −4
Configuration reference table (duplicated YAML comment content; covered by reference link) −7
Thin "How this fits" section (thin bullets + links duplicated in See Also) −7
One-line prose descriptions before each Common Patterns code block −6
Verbose Troubleshooting subsections → compact 3-row table −24
Duplicate section-specific See Also links −2
Intro paragraph condensed −1
Total −51

What was preserved

  • All configuration examples (Quick Start YAML, Update Project and Status Update code blocks, both full workflow examples)
  • All technical details including authentication, operations list, and complete pattern code
  • All external links (just removed two internal section duplicates from See Also)
  • Troubleshooting content — repackaged into a table (symptom + solution for all three issues)

Screenshots

Playwright could not reach the documentation server due to network isolation in the CI container. The page was verified to return HTTP 200 via `curl (localhost/redacted) Visual screenshots are unavailable for this run.

References:

🗜️ Compressed by Documentation Unbloat · ● 1.1M ·

  • expires on May 2, 2026, 4:10 AM UTC

Remove redundant bullets, configuration table, thin "How this fits"
section, verbose per-pattern descriptions, and replace three Symptoms/
Solutions subsections with a compact troubleshooting table. Also trim
two duplicate section-specific See Also links.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation doc-unbloat documentation Improvements or additions to documentation labels Apr 30, 2026
@pelikhan pelikhan marked this pull request as ready for review April 30, 2026 04:14
Copilot AI review requested due to automatic review settings April 30, 2026 04:14
@pelikhan pelikhan merged commit 0292d37 into main Apr 30, 2026
3 checks passed
@pelikhan pelikhan deleted the docs/unbloat-project-tracking-94cd6334241e1b77 branch April 30, 2026 04:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR reduces the length of the Project Tracking example doc by removing redundant explanatory content while keeping the core configuration/examples intact.

Changes:

  • Condenses the introduction and removes redundant “This enables” and “How this fits” sections.
  • Removes a duplicated configuration reference table and repeated See Also links.
  • Replaces verbose troubleshooting subsections with a compact troubleshooting table.
Show a summary per file
File Description
docs/src/content/docs/examples/project-tracking.md Removes redundant prose/tables and compacts troubleshooting while preserving configuration and workflow examples.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (1)

docs/src/content/docs/examples/project-tracking.md:200

  • The See Also section no longer includes direct links to the update-project and create-project-status-update reference anchors. Given the page documents both tools, keeping at least the create-project-status-update anchor (or a combined reference link list) would preserve discoverability and avoid relying on readers to find the correct section from the general Safe Outputs reference.
## See Also

- [Safe Outputs Reference](/gh-aw/reference/safe-outputs/) - Complete safe-outputs documentation
- [Project token authentication](/gh-aw/patterns/project-ops/#project-token-authentication) - Token setup guide
  • Files reviewed: 1/1 changed files
  • Comments generated: 1

| `github-token` | string | `GITHUB_TOKEN` | Custom token with Projects permissions |
| `views` | array | - | Optional auto-created views for update-project (with name, layout, filter) |

See [Safe Outputs: Project Board Updates](/gh-aw/reference/safe-outputs/#project-board-updates-update-project) for complete configuration details.
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The “See Safe Outputs: Project Board Updates” link is used as the general configuration reference for both tools, but it points specifically to the update-project anchor. This makes it easy to miss the dedicated create-project-status-update reference section. Consider linking to the Safe Outputs reference page in general, or include separate links to both anchors (update-project and create-project-status-update).

This issue also appears on line 197 of the same file.

Suggested change
See [Safe Outputs: Project Board Updates](/gh-aw/reference/safe-outputs/#project-board-updates-update-project) for complete configuration details.
See [Safe Outputs: Project Board Updates - update-project](/gh-aw/reference/safe-outputs/#project-board-updates-update-project) and [Safe Outputs: Project Board Updates - create-project-status-update](/gh-aw/reference/safe-outputs/#project-board-updates-create-project-status-update) for complete configuration details.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation doc-unbloat documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants