From 01155a3d3b35dbc4acaf26d4fb18dd044646b3ca Mon Sep 17 00:00:00 2001 From: Daniel Peng Date: Thu, 22 Jan 2026 17:50:46 +0800 Subject: [PATCH 1/2] docs(README): improve README readability and fix GIF display bug - Add internal links for configuration and demo setup - Remove redundant source tag to fix GIF animation display --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8da8294..dc54add 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ Before running StepFly, you need to configure your LLM API and MongoDB connectio #### Configure LLM API -Configure in the configuration file: +Configure in the [configuration file](./config/config.json): ```bash # Configure in config/config.json @@ -154,7 +154,7 @@ This demo demonstrates how StepFly diagnoses a critical API gateway incident whe The troubleshooting process systematically checks service versions, feature flags, regional health, partitions, components, products, and finally discovers the critical workflow failure through business scenario analysis. -**Setup**: First generate the demo database following instructions in `demo_data/README.md`: +**Setup**: First generate the demo database following instructions in [`demo_data/README.md`](./demo_data/README.md): ```bash python demo_data/generate_distributed_system_data.py ``` @@ -178,7 +178,6 @@ For demo purposes, the mapping between incident IDs and TSGs is pre-configured i #### Annimation of the DAG execution: - Description of my image From c0c700d4b1bae93889f7d5508e494ff1b25fb4ec Mon Sep 17 00:00:00 2001 From: Daniel Peng Date: Thu, 22 Jan 2026 17:58:06 +0800 Subject: [PATCH 2/2] docs(README): fix typo and improve git alt text - Fix typo "Annimation" to "Animation" in demo section - Improve GIF alt text for better accessibility --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc54add..50fc724 100644 --- a/README.md +++ b/README.md @@ -175,10 +175,10 @@ python run_web.py For demo purposes, the mapping between incident IDs and TSGs is pre-configured in `config/incident_tsg_map.json`. The PlanDAGs for different TSGs are stored in `TSGs/PlanDAGs/`. We provide two versions of the same TSG: one for running in series and one for parallel execution. The default is the parallel version, and you can change it in the mapping file if needed. You can tune `max_executor_number` in `config/config.json` to control parallelism. -#### Annimation of the DAG execution: +#### Animation of the DAG execution: - Description of my image + StepFly DAG execution animation #### Watch the full demo here: