Skip to content

docs(README): improve README readability, fix GIF display bug and typo #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
original4422 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(README): improve README readability, fix GIF display bug and typo #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01155a3
docs(README): improve README readability and fix GIF display bug
Jan 22, 2026
c0c700d
docs(README): fix typo and improve git alt text
Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```
Expand All @@ -175,11 +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:

<picture>
<source srcset="asset/stepfly.gif">
<img src="asset/stepfly.gif" width="400" height="200" alt="Description of my image">
<img src="asset/stepfly.gif" width="400" height="200" alt="StepFly DAG execution animation">
</picture>

#### Watch the full demo here:
Expand Down