ti.sil/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-12-12 10:55:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: improve help tool documentation with clearer usage instructions

Browse source
This commit is contained in:
ofir-frd 2025-07-29 11:30:46 +03:00
parent 1e285aca1f
commit 0b962a16e4
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/docs/tools/help.md
View file

@ -11,10 +11,11 @@ It can be invoked manually by commenting on any PR:
## Example usage
An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
Invoke the `help` tool by commenting on a PR with:
![Help 1](https://codium.ai/images/pr_agent/help1.png){width=750}
![Help tool input](https://codium.ai/images/pr_agent/help1.png){width=750}
→
![Analyze 2](https://codium.ai/images/pr_agent/help2.png){width=750}
Response will include a list of available tools:
![Help tool output](https://codium.ai/images/pr_agent/help2.png){width=750}