[docs] Unbloat: examples/project-tracking.md (-21%)#29243
Conversation
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>
There was a problem hiding this comment.
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-projectandcreate-project-status-updatereference anchors. Given the page documents both tools, keeping at least thecreate-project-status-updateanchor (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. |
There was a problem hiding this comment.
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.
| 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. |
Reduces
docs/src/content/docs/examples/project-tracking.mdfrom 255 → 202 lines (−53 lines, −20.8%) by removing five categories of bloat while preserving all essential technical content.Changes made
What was preserved
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: