elastic / elastic/ai-github-actions

[information-architecture] PR Review Addresser is missing from workflow discovery

Open Beginner friendly
#1,408 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. PR Review Addresser is promoted but absent from the main workflow catalog
**Area:** Navigation / Grouping / Consistency
**Component(s):** `docs/blog/posts/meet-the-reviewers.md`, `gh-agent-workflows/pr-review-addresser/README.md`, `docs/hooks.py`, `docs/workflows/gh-agent-workflows.md`, `mkdocs.yml`

**Problem:** The Reviewers overview presents PR Review Addresser as the follow-through step in the PR lifecycle: it says the reviewers are a pipeline and that PR Review Addresser fixes PR Review findings before humans review them (`docs/blog/posts/meet-the-reviewers.md:25-29`, `docs/blog/posts/meet-the-reviewers.md:51-57`). The workflow has user-facing install and trigger documentation (`gh-agent-workflows/pr-review-addresser/README.md:1-23`) and `docs/hooks.py:130-149` generates a docs page for every workflow directory with both a README and `example.yml`.

However, users who go to the main workflow discovery surfaces do not see PR Review Addresser listed. The workflow overview lists related PR workflows such as Mention in PR, PR Actions Fixer, PR Review, PR Review (Fork), and Update PR Body, but omits PR Review Addresser (`docs/workflows/gh-agent-workflows.md:42-64`). The MkDocs navigation likewise lists PR Review, PR Actions Detective/Fixer, Update PR Body, and PR Review (Fork), but not PR Review Addresser (`mkdocs.yml:30-44`).

This leaves users who follow the promoted reviewer pipeline unable to discover or compare the setup path from the main workflow catalog/navigation, even though the workflow is installable and documented.

**Suggested improvement:** Add PR Review Addresser to the Workflows nav and the available-workflows catalog near the PR Review / PR Review (Fork) lifecycle entries, with its trigger and purpose summarized consistently with the other PR workflows.

## Suggested Actions
- [ ] Add PR Review Addresser to `mkdocs.yml` under the PR/repository-maintenance workflow grouping.
- [ ] Add PR Review Addresser to `docs/workflows/gh-agent-workflows.md` alongside the other PR lifecycle workflows.
- [ ] Keep the catalog wording aligned with the existing `gh-agent-workflows/pr-review-addresser/README.md` trigger and install path.

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

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

Contributor guide

Open the contributing guide

Research direction

Start by comparing the PR workflow entries in mkdocs.yml and docs/workflows/gh-agent-workflows.md with gh-agent-workflows/pr-review-addresser/README.md; inspect docs/hooks.py to understand how workflow pages are generated. Add PR Review Addresser to both discovery surfaces near the related PR workflows, keeping its purpose, trigger, and install wording aligned with the README.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
84/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.