xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-18 11:30:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve markdown docs formatting for consistency and readability

Browse Source
This commit is contained in:
Peter Dave Hello
2025-04-18 02:03:47 +08:00
parent 58f6943b12
commit f0fc777a44
62 changed files with 547 additions and 403 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/tools/help_docs.md
View File

@ -3,9 +3,11 @@
The `help_docs` tool can answer a free-text question based on a git documentation folder.
It can be invoked manually by commenting on any PR or Issue:
```
/help_docs "..."
```
Or configured to be triggered automatically when a [new issue is opened](#run-as-a-github-action).
The tool assumes by default that the documentation is located in the root of the repository, at `/docs` folder.
@ -92,8 +94,8 @@ jobs:
3) Following completion of the remaining steps (such as adding secrets and relevant configurations, such as `repo_url` and `docs_path`) merge this change to your main branch.
When a new issue is opened, you should see a comment from `github-actions` bot with an auto response, assuming the question is related to the documentation of the repository.
---
---
## Configuration options