elastic / elastic/ai-github-actions

[information-architecture] Create Comment On Issue docs suggest unsupported direct workflow_dispatch usage

Open
#977 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
11
Forks
16
Avg merge
22h 9m
Merged PRs (30d)
31

Description

## Information Architecture Findings

### 1. Create Comment On Issue includes a direct-use path that cannot be triggered as documented
**Area:** Action placement / Progressive disclosure
**Component(s):** `docs/workflows/gh-agent-workflows/create-comment-on-issue.md:29-37`, `docs/workflows/gh-agent-workflows/create-comment-on-issue.md:46`, `.github/workflows/gh-aw-create-comment-on-issue.lock.yml:71`

**Problem:** The page tells users they can call the workflow directly with an issue number ("e.g., from `workflow_dispatch`") in the quick install section, but the same page's Trigger table lists only `workflow_call`, and the compiled workflow defines only `on.workflow_call`. This creates a dead-end setup path where users expect a manual-dispatch entry point that does not exist.

**Suggested improvement:** Replace the direct-call snippet with an explicit wrapper workflow example that uses `on: workflow_dispatch` and passes inputs into `gh-aw-create-comment-on-issue.lock.yml` via `workflow_call`.

## Suggested Actions
- [ ] Update `create-comment-on-issue.md` to remove/replace the unsupported direct `workflow_dispatch` guidance and add a valid wrapper pattern.

---
[What is this?](https://ela.st/github-ai-tools) | [From workflow: Trigger Information Architecture](https://github.com/elastic/ai-github-actions/actions/runs/24577860558)

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.