Text Improvements
The following user-facing text issues were found in the repository. Each is a low-effort fix.
1. create-comment-on-issue docs incorrectly describe comment-based triggers as reactions
File: docs/workflows/gh-agent-workflows/create-comment-on-issue.md (line 3)
Current text: ...rather than from an issue reaction trigger.
Suggested fix: ...rather than from an issue comment trigger.
Why: The linked workflow surface is comment-based (issue_comment), not reaction-based.
File: docs/workflows/gh-agent-workflows/create-comment-on-issue.md (line 5)
Current text: ...via "/ai" reaction).
Suggested fix: ...via an "/ai" comment).
Why: Same mismatch: /ai is parsed from comment text, not reactions.
2. Security guidance implies all GitHub Agent Workflows use /ai, but examples show multiple slash commands
File: SECURITY.md (line 19)
Current text: ...trigger keyword varies by system — "/ai" for GitHub Agent Workflows...
Suggested fix: ...trigger command varies by workflow (for example: "/ai", "/plan", "/docs-review", "/gemini", "/research")...
Why: Current wording is misleading versus actual examples:
gh-agent-workflows/plan/example.yml (line 17) uses /plan
gh-agent-workflows/estc-docs-pr-review/example.yml (line 17) uses /docs-review
gh-agent-workflows/internal-gemini-cli/example.yml (line 17) uses /gemini
gh-agent-workflows/internal-gemini-cli-web-search/example.yml (line 17) uses /research
3. make help points users at markdown docs instead of workflow templates
File: Makefile (line 52)
Current text: Edit claude-workflows/*/action.yml (composite actions) or gh-agent-workflows/*.md (agentic workflows).
Suggested fix: Edit claude-workflows/*/action.yml (composite actions) or gh-agent-workflows/*/example.yml (agentic workflow templates).
Why: gh-agent-workflows/*.md expands to docs/meta files, while template workflows live under gh-agent-workflows/*/example.yml.
Suggested Actions
What is this? | From workflow: Trigger Text Auditor
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
Text Improvements
The following user-facing text issues were found in the repository. Each is a low-effort fix.
1.
create-comment-on-issuedocs incorrectly describe comment-based triggers as reactionsFile:
docs/workflows/gh-agent-workflows/create-comment-on-issue.md(line 3)Current text:
...rather than from an issue reaction trigger.Suggested fix:
...rather than from an issue comment trigger.Why: The linked workflow surface is comment-based (
issue_comment), not reaction-based.File:
docs/workflows/gh-agent-workflows/create-comment-on-issue.md(line 5)Current text:
...via "/ai" reaction).Suggested fix:
...via an "/ai" comment).Why: Same mismatch:
/aiis parsed from comment text, not reactions.2. Security guidance implies all GitHub Agent Workflows use
/ai, but examples show multiple slash commandsFile:
SECURITY.md(line 19)Current text:
...trigger keyword varies by system — "/ai" for GitHub Agent Workflows...Suggested fix:
...trigger command varies by workflow (for example: "/ai", "/plan", "/docs-review", "/gemini", "/research")...Why: Current wording is misleading versus actual examples:
gh-agent-workflows/plan/example.yml(line 17) uses/plangh-agent-workflows/estc-docs-pr-review/example.yml(line 17) uses/docs-reviewgh-agent-workflows/internal-gemini-cli/example.yml(line 17) uses/geminigh-agent-workflows/internal-gemini-cli-web-search/example.yml(line 17) uses/research3.
make helppoints users at markdown docs instead of workflow templatesFile:
Makefile(line 52)Current text:
Edit claude-workflows/*/action.yml (composite actions) or gh-agent-workflows/*.md (agentic workflows).Suggested fix:
Edit claude-workflows/*/action.yml (composite actions) or gh-agent-workflows/*/example.yml (agentic workflow templates).Why:
gh-agent-workflows/*.mdexpands to docs/meta files, while template workflows live undergh-agent-workflows/*/example.yml.Suggested Actions
docs/workflows/gh-agent-workflows/create-comment-on-issue.md.SECURITY.mdtrigger wording to reflect that slash commands vary by workflow, not one global/aikeyword.Makefilehelp text so it points to the actual agentic workflow template files.What is this? | From workflow: Trigger Text Auditor
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.