Document SRE Agent investigation workflows and mitigation playbooks in README, and add Arabic translation - #2
Draft
AlahmadiQ8 with Copilot wants to merge 4 commits into
Draft
Document SRE Agent investigation workflows and mitigation playbooks in README, and add Arabic translation#2AlahmadiQ8 with Copilot wants to merge 4 commits into
AlahmadiQ8 with Copilot wants to merge 4 commits into
Conversation
Copilot
AI
changed the title
[WIP] Update README documentation for better clarity
Document SRE Agent investigation workflows and mitigation playbooks in README
Jun 18, 2026
Owner
|
@copilot update the readme to include full Arabic section. |
Author
Added a full Arabic (العربية) section to the README with RTL layout, covering architecture, tech stack, prerequisites, quick start, chaos scenarios, SRE Agent setup, tests, and cleanup. Also added a language selector at the top linking between English and Arabic. Done in commit 03c92ef.
Correction: the Arabic section was added in commit 819dcc2. |
Copilot
AI
changed the title
Document SRE Agent investigation workflows and mitigation playbooks in README
Document SRE Agent investigation workflows and mitigation playbooks in README, and add Arabic translation
Jun 18, 2026
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.
The README contained two empty
TODOplaceholders (Investigation Workflows, Mitigation Playbooks) and lacked top-level navigation. This fills those gaps with documentation derived directly from the codebase, and adds a full Arabic translation.Changes
A1–A10), primary telemetry signal, and a distinguishing clue (e.g. Slow API vs. CPU/memory saturation). Includes a 4-step investigation guide and an example KQL query keyed off theChaosScenario activatedlog marker.CancellationTokenSource/DefaultDuration), the memory-leak caveat (GC may not reclaim until process restart), and a guaranteed clean-reset command.RG_NAMEto avoid copy-paste errors.<div dir="rtl">), covering architecture, tech stack, prerequisites, quick start, chaos scenarios, SRE Agent setup, tests, and cleanup, plus a language selector at the top linking between English and Arabic.Content is sourced from
ChaosService.cs,infra/modules/alerts.bicep, and the customContosoBankmeter; internal links toDEMO.mdanchors are verified. Documentation-only — no source code touched.