docs: Enhance investigation and integration documentation#2807
Conversation
- Added a new "Investigation workflow" section detailing the structured RCA pipeline for alerts. - Updated "Integrations overview" to clarify setup paths and added a catalog of available integrations. - Introduced a new "Benchmark" group in the documentation navigation. - Improved descriptions and examples for using the interactive shell and session management. - Added a link to the hermes_runbook for contributors in the Hermes documentation. - Removed outdated AWS and macOS integration pages to streamline content.
Greptile code reviewThis repo uses Greptile for automated review. Before merge, aim for Confidence Score: 5/5 with zero unresolved review threads — see CONTRIBUTING.md. Run a review — add a PR comment with: Give it ~5-10 minutes (sometimes longer) for results, then fix feedback and re-trigger until you reach Confidence Score: 5/5. Optional: automate with the greploop skill. |
Greptile SummaryThis PR enhances the OpenSRE documentation by rewriting several pages for clarity, adding new overview pages for investigations and benchmarking, restructuring the integrations guide into local-CLI and hosted paths, expanding session-exit documentation, and removing two orphaned integration files.
Confidence Score: 5/5Documentation-only changes with no code impact; all cross-links and navigation entries verified. Every page referenced in the updated navigation exists on disk, deleted files were confirmed orphans not present in docs.json, and all internal cross-links resolve to valid nav entries. The changes are additive improvements with no regressions. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User] -->|"opensre (TTY)"| B[Interactive REPL]
A -->|"opensre investigate -i alert.json"| C[Direct Investigation]
B -->|Plain-language or slash command| D[REPL Planner]
D -->|Routes intent| E["Slash Commands\n/health, /integrations, /investigate…"]
E --> F[Investigation Pipeline]
C --> F
F --> G["Extract context\nfrom alert + integrations"]
G --> H["Plan evidence collection\nlogs, metrics, deploys"]
H --> I["Test hypotheses\ntool-calling loop"]
I --> J["Publish artifacts\nproblem.md / report.md / rca.json"]
J -->|If Slack configured| K[Slack report]
B -->|On exit| L["Session persisted\n~/.opensre/sessions/"]
L -->|Resume hint printed| A
Reviews (2): Last reviewed commit: "docs: Update link to hermes_runbook in H..." | Re-trigger Greptile |
- Corrected the file extension in the link to the hermes_runbook from `.md` to `.mdx` for accuracy.
|
@greptile-apps review again |
|
💜 One more reason the project grows. Thanks @Devesh36 — your contribution just landed! 👋 Join us on Discord - OpenSRE : hang out, contribute, or hunt for features and issues. Everyone's welcome. |

This pull request makes significant improvements to the OpenSRE documentation, focusing on clarifying investigation workflows, integrations setup, and session management. It adds new overview pages, refines the features list, and restructures integration guides for better usability. Additionally, it removes outdated or redundant documentation.
Documentation structure and navigation:
docs/integrations/aws.mdxanddocs/integrations/macos.mdx, which are no longer relevant or have been superseded. [1] [2]Investigation workflow and features:
Integrations setup and catalog:
Session management and continuity:
Masking and privacy:
Hermes contributor workflow: