From d3bc823dfbd848359785e9318e787f9067db26db Mon Sep 17 00:00:00 2001 From: PSBigBig + MiniPS Date: Sun, 15 Mar 2026 20:52:49 +0800 Subject: [PATCH] Update README.md --- .../demo-f5-observability-first/README.md | 149 ++++++++++++------ 1 file changed, 103 insertions(+), 46 deletions(-) diff --git a/ProblemMap/Atlas/Fixes/official/demos/demo-f5-observability-first/README.md b/ProblemMap/Atlas/Fixes/official/demos/demo-f5-observability-first/README.md index fe760cdb..6b8b54eb 100644 --- a/ProblemMap/Atlas/Fixes/official/demos/demo-f5-observability-first/README.md +++ b/ProblemMap/Atlas/Fixes/official/demos/demo-f5-observability-first/README.md @@ -39,13 +39,31 @@ AI_NOTE_END ## Problem Map 3.0 Troubleshooting Atlas ## Official flagship demo for diagnosability-first repair +Quick links: + +- [Back to demo pack index](../README.md) +- [Back to AI Eval Evidence](../../../../ai-eval-evidence.md) +- [Back to Atlas landing page](../../../../../wfgy-ai-problem-map-troubleshooting-atlas.md) +- [Open Atlas Hub](../../../../README.md) +- [Get the Atlas Router TXT](../../../../troubleshooting-atlas-router-v1.txt) + [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/onestardao/WFGY/blob/Atlas/ProblemMap/Atlas/Fixes/official/demos/demo-f5-observability-first/demo_02_f5_observability_first_replay_v2.ipynb) +Open in Colab if you want the recommended replay notebook view. +The README and replay artifacts are already enough to understand the teaching pattern. + **Replay-only MVP** **No API key required** This is the second flagship demo in the official runnable demo pack. +If the AI eval snapshots suggest that better routing may reduce hidden debugging waste, this page goes one step further. + +This demo is meant to make one mechanism-level claim visible: + +> when the real bottleneck is diagnosability, +> the first repair move becomes visibility uplift, not premature workflow surgery + It was chosen because many real systems fail in a painful but very common way: > something is clearly going wrong @@ -57,38 +75,19 @@ It shows that once a case is routed as **F5 Observability & Diagnosability Integ --- -## Current notebook versions +## Quick start -This folder currently preserves **two replay notebook versions**. +If you want the shortest path through this demo, use this order: -### Recommended version +1. read **Section 1 · What this demo proves** +2. read **Section 3 · Why not F4 first** +3. read **Section 5 · First repair move** +4. open [replay_outputs.json](./replay_outputs.json) +5. open the recommended replay notebook only if you want the notebook presentation in Colab -- `demo_02_f5_observability_first_replay_v2.ipynb` +If you only want the takeaway, this demo teaches one clean lesson: -This is the current recommended notebook for public reading, Colab use, and MVP presentation. - -It keeps the replay-first design, while adding: - -- clearer route summary -- clearer before / after contrast -- stronger teaching framing -- better aligned shared-layer presentation - -### Original version - -- `demo_02_f5_observability_first_replay.ipynb` - -This version is intentionally retained. - -It remains part of the demo history and preserves the earlier first-pass MVP presentation. - -### Version rule - -The rule for this folder is simple: - -- **v1 is preserved** -- **v2 is the recommended replay notebook** -- replay-first remains the official design center for Demo 2 +> if the system is still too opaque to diagnose correctly, repair visibility first --- @@ -307,39 +306,80 @@ Replay mode proves that: This is enough for the first public MVP. +Core replay artifacts: + +- [input_case.json](./input_case.json) +- [replay_outputs.json](./replay_outputs.json) +- [expected_output.json](./expected_output.json) + --- -## 7. Files in this folder +## 7. Current notebook versions -### Required +This folder currently preserves **two replay notebook versions**. + +### Recommended version -- `README.md` -- `input_case.json` -- `replay_outputs.json` -- `expected_output.json` -- `demo_02_f5_observability_first_replay.ipynb` - `demo_02_f5_observability_first_replay_v2.ipynb` +This is the current recommended notebook for public reading, Colab use, and MVP presentation. + +It keeps the replay-first design, while adding: + +- clearer route summary +- clearer before / after contrast +- stronger teaching framing +- better aligned shared-layer presentation + +### Original version + +- `demo_02_f5_observability_first_replay.ipynb` + +This version is intentionally retained. + +It remains part of the demo history and preserves the earlier first-pass MVP presentation. + +### Version rule + +The rule for this folder is simple: + +- **v1 is preserved** +- **v2 is the recommended replay notebook** +- replay-first remains the official design center for Demo 2 + +--- + +## 8. Files in this folder + +### Core files + +- [README.md](./README.md) +- [input_case.json](./input_case.json) +- [replay_outputs.json](./replay_outputs.json) +- [expected_output.json](./expected_output.json) +- [demo_02_f5_observability_first_replay.ipynb](./demo_02_f5_observability_first_replay.ipynb) +- [demo_02_f5_observability_first_replay_v2.ipynb](./demo_02_f5_observability_first_replay_v2.ipynb) + ### File roles -#### `input_case.json` +#### [input_case.json](./input_case.json) Contains the workflow case, visible artifacts, and missing-diagnosability context. -#### `replay_outputs.json` +#### [replay_outputs.json](./replay_outputs.json) Contains the baseline state, route explanation, first repair move, and improved visibility state. -#### `expected_output.json` +#### [expected_output.json](./expected_output.json) Contains the clean target structure for what the demo is meant to make visible. -#### `demo_02_f5_observability_first_replay.ipynb` +#### [demo_02_f5_observability_first_replay.ipynb](./demo_02_f5_observability_first_replay.ipynb) The original first-pass replay notebook retained for continuity. -#### `demo_02_f5_observability_first_replay_v2.ipynb` +#### [demo_02_f5_observability_first_replay_v2.ipynb](./demo_02_f5_observability_first_replay_v2.ipynb) The current recommended replay notebook for public reading and Colab use. --- -## 8. Expected outcome +## 9. Expected outcome If the demo works, the user should walk away with the following understanding: @@ -356,7 +396,7 @@ That is enough. --- -## 9. Limits of this demo +## 10. Limits of this demo This demo has real limits, and those limits should be stated clearly. @@ -379,7 +419,7 @@ There is no need to inflate them. --- -## 10. Why this demo matters +## 11. Why this demo matters This demo teaches one clean lesson: @@ -397,9 +437,26 @@ It turns F5 from an abstract family label into a practical debugging move. --- +## Next steps + +After this page, most readers continue with: + +1. [Back to the demo pack index](../README.md) +2. [Back to AI Eval Evidence](../../../../ai-eval-evidence.md) +3. [Back to the Atlas landing page](../../../../../wfgy-ai-problem-map-troubleshooting-atlas.md) +4. [Open the Atlas Router TXT](../../../../troubleshooting-atlas-router-v1.txt) + +If this demo helped you understand the Atlas, consider: + +- [starring the WFGY repo](https://github.com/onestardao/WFGY) +- opening an issue +- testing the replay artifacts +- comparing v1 and v2 notebook presentation +- using the demo as a pattern for your own observability-first cases + +--- + ## Back to the main page Read the full product page here: -[Problem Map 3.0 Troubleshooting Atlas](https://github.com/onestardao/WFGY/blob/main/ProblemMap/wfgy-ai-problem-map-troubleshooting-atlas.md) - -If you like the project, star the repo ⭐ +[Problem Map 3.0 Troubleshooting Atlas](../../../../../wfgy-ai-problem-map-troubleshooting-atlas.md)