[docs] docs: unbloat footers.md — remove redundant sections#27753
[docs] docs: unbloat footers.md — remove redundant sections#27753
Conversation
Removed 52 lines (36%) of bloat from reference/footers.md: - Merged XML marker list into Global Footer Control (was repeated in separate section) - Condensed search examples from 4 to 2 (all variations of same pattern) - Removed Use Cases section (redundant with Per-Handler Footer Control examples) - Tightened Backward Compatibility to one sentence All technical content and links preserved. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions
Bot
added
automation
doc-unbloat
documentation
There was a problem hiding this comment.
Pull request overview
Reduces redundancy in the Footer Control reference by consolidating repeated sections and trimming examples while keeping core configuration and search guidance intact.
Changes:
- Consolidated the “hidden XML markers” details into the Global Footer Control section.
- Reduced GitHub search examples to two representative queries.
- Condensed the backward-compatibility note.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/footers.md | Removes duplicated sections and tightens guidance around footer hiding and search markers. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
| When `footer: false` is set, visible attribution text is omitted from item bodies but hidden XML markers (workflow-id, tracker-id) remain for searchability. Applies to all output types: create-issue, create-pull-request, create-discussion, update-issue, update-pull-request, update-discussion, and update-release. | ||
| When `footer: false` is set, visible attribution text is omitted from item bodies but hidden XML markers remain for searchability: | ||
| - `<!-- gh-aw-workflow-id: WORKFLOW_NAME -->` — for search and tracking | ||
| - `<!-- gh-aw-tracker-id: unique-id -->` — for issue/discussion tracking |
There was a problem hiding this comment.
The docs now imply the gh-aw-tracker-id hidden marker is always present when footer: false, but tracker-id appears to be optional in the frontmatter reference (and therefore the marker would only exist when a tracker-id is configured). Consider clarifying this bullet (e.g., "when tracker-id is set") to avoid misleading readers.
| - `<!-- gh-aw-tracker-id: unique-id -->` — for issue/discussion tracking | |
| - `<!-- gh-aw-tracker-id: unique-id -->` — for issue/discussion tracking when `tracker-id` is set |
|
|
||
| ### Searching for Workflow-Created Items | ||
|
|
||
| Use the `gh-aw-workflow-id` marker (the workflow filename without `.md`) to find items in GitHub search: |
There was a problem hiding this comment.
This sentence says the workflow-id value is "the workflow filename without .md", but other docs describe it more generally as a workflow name/identifier. To keep references consistent (and avoid potentially incorrect guidance if the marker value differs from the filename), consider rephrasing to match the established wording used in safe-outputs.md (e.g., "workflow name" or "WORKFLOW_NAME").
| Use the `gh-aw-workflow-id` marker (the workflow filename without `.md`) to find items in GitHub search: | |
| Use the `gh-aw-workflow-id` marker (the workflow name) to find items in GitHub search: |
Summary
docs/src/content/docs/reference/footers.mddocs/unbloat-footersBloat removed
All essential content preserved
Screenshots
Screenshots were unavailable due to network isolation between the Playwright container and the agent container (known AWF constraint). Page was verified to render correctly via
curl— HTTP 200, full HTML returned from the Astro dev server at/gh-aw/reference/footers/.References: