Skip to content

docs: fix factual errors in README and ARCHITECTURE - #4

Merged
sdOps merged 2 commits into
mainfrom
fix/broken-links
Sep 20, 2026
Merged

sdOps merged 2 commits into
mainfrom
fix/broken-links

Conversation

@sdOps

@sdOps sdOps commented Sep 20, 2026 •

Copy link
Copy Markdown
Owner

Fixes a few small factual errors in the docs that a reader will hit in the first five minutes.

What changed:

  • Replaced the broken Pi GitHub link in README.md. https://github.com/earendil-works/pi-coding-agent 404s; the repo is https://github.com/earendil-works/pi. Verified the rest of the external links in README.md and ARCHITECTURE.md still resolve.
  • Updated the tool count from 12 to 13. README.md and ARCHITECTURE.md §3.3 both said 12 tools, but argusTools in argus-server/tools/argus-tools.ts exports 13: the original 12 plus list_all_alerts.
  • Filled in the missing rows in the README Agent tools table. Added list_all_alerts and check_logs with one-line descriptions taken from each tool's own description field, so the table now has exactly one row per registered tool.
  • Updated ARCHITECTURE.md §3.3 and the repo layout note to say 13 tools, and added list_all_alerts to the toolbelt list.
  • Added list_all_alerts to the system prompt tool list and to the RCA research instructions. That tool is registered with Pi, so the model should know it exists. This is a docs-only change to the prompt; it does not alter tool behavior.

Verification:

  • Ran the db scenario end to end in mise run dev with qwen3.6:latest. The agent opened an incident on pgsql, proposed remediation, recovered after approval, and reached resolved with an RCA. No regression.
  • mise run typecheck, mise run test, bun run --cwd argus-ui build, and docker compose build all pass.

Closes #5

README.md and ARCHITECTURE.md claimed 12 tools but argusTools exports 13:
the original 12 plus list_all_alerts. Add list_all_alerts and check_logs to
the README table and update all '12' references to '13'. Also add
list_all_alerts to the system prompt tool list and RCA instructions so the
model knows about the registered tool.
@sdOps sdOps self-assigned this Sep 20, 2026
@sdOps
sdOps merged commit 582b336 into main Sep 20, 2026
5 checks passed
@sdOps
sdOps deleted the fix/broken-links branch September 20, 2026 23:05
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.

docs: factual errors in README and ARCHITECTURE — broken Pi link and wrong tool count

1 participant