github / github/gh-aw

[deep-report] Fix chat-ops.md example that does not use the steps.sanitized.outputs.text it describes

Open Beginner friendly
#61,189 0 comments 0 reactions 0 assignees View on GitHub
automation code-quality cookie documentation improvement quick-win task-mining
Dominant language
Go
Stars
5.1k
Forks
541
Avg merge
5h 48m
Merged PRs (30d)
773

Description

### Description
`docs/src/content/docs/patterns/chat-ops.md` (line 25) states that the ChatOps code-review example "references the triggering content via `steps.sanitized.outputs.text`", but the fenced example immediately below (lines 27-51) never actually uses that variable anywhere in its prompt body. A user copying the example verbatim won't find what the prose promised. Flagged and live-verified in the 2026-09-15 User Experience Analysis Report.

### Expected Impact
Restores trust/accuracy in a featured, frequently-linked pattern doc (cross-referenced from IssueOps/DispatchOps/LabelOps) so the example matches its own description.

### Suggested Fix
Add a line to the example's prompt body referencing `${{ steps.sanitized.outputs.text }}`, e.g. inserting `Triggering comment (sanitized): ${{ steps.sanitized.outputs.text }}` between the intro sentence and the "Examine the diff..." paragraph.

### Suggested Agent
Delight / docs-focused agent

### Estimated Effort
Quick (< 30 min)

### Data Source
DeepReport Intelligence Briefing analysis, 2026-09-15 cycle 3 — derived from User Experience Analysis Report - 2026-09-15 (#61155)

> [!WARNING]
>
> Firewall blocked 1 domain
>
> The following domain was blocked by the firewall during workflow execution:
>
> - `api.anthropic.com`
>
> To allow these domains, add them to the `network.allowed` list in your workflow frontmatter:
>
> ```yaml
> network:
> allowed:
> - defaults
> - "api.anthropic.com"
> ```
>
> See [Network Configuration](https://github.github.com/gh-aw/reference/network/) for more information.
>
>

> Generated by [🔬 Deep Report](https://github.com/github/gh-aw/actions/runs/35007359021) · claude · agent · 221.8 AIC · ⌖ 11.2 AIC · ⊞ 12.8K · [◷](https://github.com/search?q=repo%3Agithub%2Fgh-aw+is%3Aissue+%22gh-aw-workflow-call-id%3A+github%2Fgh-aw%2Fdeep-report%22&type=issues)
> - [x] expires on Sep 17, 2026, 10:41 AM UTC-08:00

Contributor guide

Open the contributing guide

Research direction

Open docs/src/content/docs/patterns/chat-ops.md and inspect the description around line 25 and the fenced example on lines 27-51. Add the documented steps.sanitized.outputs.text reference to the prompt body, then verify the example matches the surrounding prose and renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
95/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.