docs(readme): reframe for cloud incident triage in plain language#62
Open
sourcehawk wants to merge 1 commit into
Open
docs(readme): reframe for cloud incident triage in plain language#62sourcehawk wants to merge 1 commit into
sourcehawk wants to merge 1 commit into
Conversation
Rewrite the README so an SRE/platform engineer without AI background can tell what triagent is and get it running: - Lead with the general capability (cloud incident triage) and list the surfaces it reaches as peers (Kubernetes, AWS, GCP, Prometheus, Slack, GitHub, incident.io) rather than anchoring everything on Kubernetes. - Gloss the AI terms inline (agent, MCP, playbook, walker) instead of assuming them; explain the Claude Code dependency and that investigation context is sent to Claude. - State the safety and operating model plainly: read-only cluster/cloud access, the only writes are reviewed Git PRs, runs per-laptop, teams share via Git. - Trim the command list to `triagent help` plus the two start forms. - Drop the internal "preflight" vocabulary from the user-facing flow. - Add the contributor merge bar (frontend typecheck) and a PATH note. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Docs-only rewrite of README.md that reframes triagent from Kubernetes-first "agentic incident investigation" toward cloud incident triage in plain language, glossing AI vocabulary inline and clarifying the operating/safety model. Also trims the command list, drops the now-inaccurate user-facing preflight step, and updates the contributor section to reflect that frontend typecheck is a CI gate not covered by make test.
Changes:
- Replace AI/architecture-led intro and "what it does" with a plainer SRE-facing pitch, glossing terms like agent, MCP, and playbook.
- Reword requirements/run flow: clarify Claude Code dependency and data egress, drop the inaccurate preflight namespace/pod-list claim, simplify command list to
helpand the twostartforms. - Add
~/.local/binPATH note and a contributor merge bar coveringmake test,make lint, andfrontend npm run typecheck.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Every tool call stays visible, so you can audit the chain or interrupt at any point. Finished sessions can be shared | ||
| so the next operator starts from where you ended, not from the alert. | ||
| It connects to the places you already look: Kubernetes, AWS, and GCP (all read-only), Prometheus, Slack, GitHub, and incident.io, plus anything else you wire up via [MCP](https://modelcontextprotocol.io) (the open standard for plugging AI assistants into tools). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Reframe the README so an SRE/platform engineer without an AI background can tell what triagent is, decide whether they want it, and get it running. The previous version led with the architecture (MCP catalog, reasoning agent, playbook walker) and anchored everything on Kubernetes. This version leads with the job, lists the surfaces it reaches as peers, and glosses the AI vocabulary inline.
Changes
triagent helpplus the twostartforms.~/.local/binPATH note.Testing
Docs-only change; no code touched. Validated the rewrite with fresh-reader passes per the writing-docs workflow: three personas (evaluating SRE, team adopter, contributor) answered their arrival questions from the revised text alone, then a follow-up pass confirmed the previously-failing questions (safety model, data egress, AWS/GCP-vs-setup consistency, deployment model, contributor merge bar) now resolve. No em dashes; one line per paragraph.