elastic / elastic/ai-github-actions
[docs-patrol] Update docs for Log Searching Agent behavior and workflow catalog
- Dominant language
- Python
- Stars
- 11
- Forks
- 16
- Avg merge
- 22h 9m
- Merged PRs (30d)
- 31
Description
Recent code changes in the repository have introduced documentation drift. The following changes need corresponding documentation updates.
## Changes Requiring Documentation Updates
### 1. Log Searching Agent README incorrectly states old issues are auto-closed
**Commit(s):**
- [06c4ed7](https://github.com/elastic/ai-github-actions/commit/06c4ed72f3e581046c97b7d4d322d70f9d4ff994)
**What changed:**
- The workflow source explicitly disables auto-closing older issues for `create-issue` safe output:
- `.github/workflows/gh-aw-log-searching-agent.md:94-98` (`close-older-issues: false`).
- The workflow README currently documents the opposite behavior:
- `gh-agent-workflows/log-searching-agent/README.md:41` says `create-issue` “auto-closes older reports”.
**Documentation impact:**
- `gh-agent-workflows/log-searching-agent/README.md` should be updated so the Safe Outputs section matches actual behavior (`close-older-issues: false`).
### 2. Central workflow catalog omits the newly added Log Searching Agent
**Commit(s):**
- [06c4ed7](https://github.com/elastic/ai-github-actions/commit/06c4ed72f3e581046c97b7d4d322d70f9d4ff994)
- [622701b](https://github.com/elastic/ai-github-actions/commit/622701b0d8987db8965be34a8df7f776444abf68)
**What changed:**
- A new public workflow and docs were added:
- `.github/workflows/gh-aw-log-searching-agent.md`
- `gh-agent-workflows/log-searching-agent/README.md`
- `gh-agent-workflows/log-searching-agent/example.yml`
- The central “Available workflows” page does not list this workflow:
- `docs/workflows/gh-agent-workflows.md:51-64` (Event-driven workflows table has no Log Searching Agent entry).
**Documentation impact:**
- `docs/workflows/gh-agent-workflows.md` should add a row for Log Searching Agent so the workflow catalog reflects currently available workflows.
## Suggested Actions
- [ ] Update `gh-agent-workflows/log-searching-agent/README.md` Safe Outputs text to reflect `close-older-issues: false`.
- [ ] Add Log Searching Agent to the Event-driven workflows table in `docs/workflows/gh-agent-workflows.md` with trigger and purpose.
---
[What is this?](https://ela.st/github-ai-tools) | [From workflow: Trigger Docs Patrol](https://github.com/elastic/ai-github-actions/actions/runs/34362509928)
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
> - [x] expires on Sep 16, 2026, 2:27 PM UTC
Contributor guide
Research direction
Read .github/workflows/gh-aw-log-searching-agent.md and gh-agent-workflows/log-searching-agent/README.md to confirm the safe-output behavior, then inspect docs/workflows/gh-agent-workflows.md for the event-driven workflow table. Done means the README no longer claims older reports are auto-closed and the catalog includes the Log Searching Agent with its trigger and purpose.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100