Skip to content

Comments

Add "How it works" sections to all agent READMEs#218

Merged
strawgate merged 4 commits intomainfrom
copilot/update-agent-docs
Feb 20, 2026
Merged

Add "How it works" sections to all agent READMEs#218
strawgate merged 4 commits intomainfrom
copilot/update-agent-docs

Conversation

Copy link
Contributor

Copilot AI commented Feb 20, 2026

  • Add ## How it works section to all 27 agent READMEs
  • stale-issues and docs-pr-review already have equivalent detail sections — left unchanged
  • Remove /ai coupling from mention-in-issue and mention-in-pr — the prefix is only in the example trigger and is configurable
  • make compile passes (0 errors, 0 warnings)
  • make lint passes
Original prompt

This section details on the original issue you should resolve

<issue_title>Update docs with more info about Agents</issue_title>
<issue_description>Let's update the Agent readmes with more info about what they do and what their goals are. Keep it concise. But for example, the small problem fixer searches for github issues it can solve and tries to solve them with X criteria.</issue_description>

Comments on the Issue (you are @copilot in this section)

Custom agent used: default-agent
The default agent


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Update docs with more info about Agents Add "How it works" sections to all agent READMEs Feb 20, 2026
Copilot AI requested a review from strawgate February 20, 2026 15:33
@strawgate strawgate marked this pull request as ready for review February 20, 2026 15:40
Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
@strawgate strawgate force-pushed the copilot/update-agent-docs branch from 0b041e4 to a2af320 Compare February 20, 2026 15:40
@strawgate
Copy link
Collaborator

@copilot i dont think our mention workflows actually have anything to do with /ai that's actually just in the example trigger, let's update the docs accordingly

@github-actions
Copy link
Contributor

Checks failed because compiled workflow artifacts are out of date, not because of the README content changes.

  • Failing job: Verify compiled workflows (run 22230475840), step Ensure lock files are up to date.
  • Log evidence: after make compile, the workflow detects a dirty tree with many modified .github/workflows/*.lock.yml, plus new files gh-aw-docs-drift-external.lock.yml, gh-aw-docs-new-contributor-review-external.lock.yml, trigger-docs-drift-external.yml, and trigger-docs-new-contributor-review-external.yml.
  • Reproduced locally on PR branch (pr-218) with make compile; git status --porcelain reported the same dirty workflow outputs.

Recommended fix:

  1. Run make compile from this PR branch.
  2. Commit all resulting generated files under .github/workflows/ (including the two new lock files and two new trigger files).
  3. Push and re-run CI.

What I ran:

  • Retrieved job list and failed logs for run 22230475840.
  • Checked PR metadata (#218) and confirmed it is same-repo.
  • Reproduced with make compile and verified dirty-tree output.

I did not push a commit in this run.


What is this? | From workflow: PR Checks Fixer

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

Copy link
Contributor Author

Copilot AI commented Feb 20, 2026

@copilot i dont think our mention workflows actually have anything to do with /ai that's actually just in the example trigger, let's update the docs accordingly

Updated in e9429fb. Removed the /ai coupling from both mention-in-issue and mention-in-pr — the one-liners, ## How it works sections, and Trigger table conditions now all reflect that /ai is just the example prefix and is configurable by the repo owner.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/ruby/setup-ruby/git/ref/tags/v1
    • Triggering command: /usr/bin/gh gh api /repos/ruby/setup-ruby/git/ref/tags/v1 --jq .object.sha -c=4 -nolocalimports -importcfg /tmp/go-build1657173413/b333/importcfg -pack /home/REDACTED/go/pkg/mod/github.com/spf13/cobra@v1.10.2/active_help.go /home/REDACTED/go/pkg/mod/github.com/spf13/cobra@v1.10.2/args.go (http block)
    • Triggering command: /usr/bin/gh gh api /repos/ruby/setup-ruby/git/ref/tags/v1 --jq .object.sha go1.25.7 -c=4 -nolocalimports -importcfg /tmp/go-build1657173413/b253/importcfg -pack /home/REDACTED/go/pkg/mod/golang.org/toolchain@v0.0.1-go1.25.7.linux-amd64/src/net/http/internal/httpcommon/httpcommon.go (http block)
    • Triggering command: /usr/bin/gh gh api /repos/ruby/setup-ruby/git/ref/tags/v1 --jq .object.sha -c=4 -nolocalimports -importcfg /tmp/go-build1657173413/b256/importcfg -pack /home/REDACTED/go/pkg/mod/github.com/henvic/httpretty@v0.1.4/internal/header/header.go rg/toolchain@v0.-I (http block)
  • https://api.github.com/user
    • Triggering command: /usr/bin/gh gh api user --jq .login /tmp/go-build1657173413/b337/symabis -c=4 -nolocalimports -importcfg /tmp/go-build1657173413/b337/importcfg -pack -asmhdr (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
@strawgate strawgate force-pushed the copilot/update-agent-docs branch from e9429fb to deacdd9 Compare February 20, 2026 15:49
@strawgate strawgate merged commit 3ecdd78 into main Feb 20, 2026
4 of 5 checks passed
@strawgate strawgate deleted the copilot/update-agent-docs branch February 20, 2026 15:50
@github-actions
Copy link
Contributor

CI failure in run 22230626732 is from job Verify compiled workflows, step Ensure lock files are up to date: make compile left the working tree dirty (.github/workflows/agentics-maintenance.yml plus many gh-aw-*.lock.yml files), so the step exited with status 1.

I verified locally on branch origin/copilot/update-agent-docs (current tip e9429fb) by running make compile; it exits successfully and leaves no local diff, so the failing run appears tied to an earlier commit state (e8c7806) rather than the current branch tip.

No safe minimal code push was made from this run; if this branch is reopened/used again and the check fails, regenerate and commit compiled workflow outputs before rerunning CI.


What is this? | From workflow: PR Checks Fixer

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs with more info about Agents

2 participants