elastic / elastic/ai-github-actions

[information-architecture] Text Auditor quick install omits the chained detector+fixer setup path

Open
#849 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. Chaining is presented as available, but the primary setup flow only exposes auditor-only install
**Area:** Progressive disclosure / Action placement
**Component(s):** `docs/workflows/gh-agent-workflows/text-quality.md`, `gh-agent-workflows/text-auditor/README.md`, `docs/workflows/gh-agent-workflows/bugs.md`, `docs/workflows/gh-agent-workflows/test-coverage.md`

**Problem:**
Users are told Text Auditor can be chained into an autonomous detector+fixer loop, but the Quick install path only shows the auditor-only workflow. The "do this now" setup entry point does not expose the chained path where users expect it, so users who want autonomous operation must rediscover and hand-wire it.

**Evidence:**
- `docs/workflows/gh-agent-workflows/text-quality.md:5` says Text Auditor can be chained to Create PR from Issue.
- `docs/workflows/gh-agent-workflows/text-quality.md:7-15` provides only one Quick install snippet (`text-auditor/example.yml`), with no chained install block.
- `gh-agent-workflows/text-auditor/README.md:5` also advertises chaining, but `gh-agent-workflows/text-auditor/README.md:9-17` provides only the detector-only install snippet.
- Comparable detector docs expose both paths in Quick install:
- `docs/workflows/gh-agent-workflows/bugs.md:9-27` includes `Detector only` and `Chained (detector + fixer)`.
- `docs/workflows/gh-agent-workflows/test-coverage.md:9-27` includes `Detector only` and `Chained (detector + fixer)`.

**Suggested improvement:**
Add a second Quick install option for Text Auditor (`Chained (detector + fixer)`), with a concrete snippet (and `example-chained.yml` reference if supported), so users can choose autonomous vs human-in-the-loop setup at the same decision point.

## Suggested Actions
- [ ] Add a `Chained (detector + fixer)` subsection to `docs/workflows/gh-agent-workflows/text-quality.md` with a copy-paste install snippet.
- [ ] Mirror the same chained install path in `gh-agent-workflows/text-auditor/README.md` to keep setup guidance consistent.
- [ ] If chaining is intentionally unsupported, remove/clarify the current chaining claim to avoid a misleading primary setup path.

> [!NOTE]
>
> 🔒 Integrity filtering filtered 2 items
>
> Integrity filtering activated and filtered the following items during workflow execution.
> This happens when a tool call accesses a resource that does not meet the required integrity or secrecy level of the workflow.
>
> - issue:elastic/ai-github-actions#779 (`issue_read`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
> - issue:#unknown (`search_issues`: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
>
>

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

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.