Skip to content

Commit 15104b8

Browse files
Add tutorial screenshots to README
Add a 'See It in Action' section to the README showing the three validation phases (Orchestrator, Analyst, Executor) with explanatory captions. Also add the corresponding image assets (docs/images/image.png, image-1.png, image-2.png) used by the new section.
1 parent 065d078 commit 15104b8

File tree

4 files changed

+16
-0
lines changed

4 files changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@ TutorialValidator is an AI-powered tool that checks whether a software documenta
77

88
We originally built it internally to validate [ABP Framework](https://abp.io) tutorials, and then decided to publish it as open source so you can use it to validate any publicly accessible tutorial.
99

10+
## See It in Action
11+
12+
The following screenshots show the three main phases of a validation run.
13+
14+
**Orchestrator** — coordinates the full pipeline, launching the Analyst and Executor in sequence and collecting the final results.
15+
16+
![Orchestrator](docs/images/image.png)
17+
18+
**Analyst** — scrapes the tutorial pages and uses AI to extract every instruction into a structured, executable test plan.
19+
20+
![Analyst](docs/images/image-1.png)
21+
22+
**Executor** — works through the test plan step by step, running commands, writing files, and asserting outcomes just as a real developer would.
23+
24+
![Executor](docs/images/image-2.png)
25+
1026
---
1127

1228
## Prerequisites

docs/images/image-1.png

42.8 KB
Loading

docs/images/image-2.png

68.5 KB
Loading

docs/images/image.png

37.6 KB
Loading

0 commit comments

Comments
 (0)