Skip to content

Commit 7977855

Browse files
Merge pull request #25214 from abpframework/ebicoglu-patch-3
Update article for AI Tutorial Validator
2 parents 7b7b07e + 977f793 commit 7977855

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

  • docs/en/Community-Articles/2026-03-10-Tutorial-Validator

docs/en/Community-Articles/2026-03-10-Tutorial-Validator/article.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Automatically Validate Your Documentation: How We Built a Tutorial Validator
1+
# Automatically Validate Your Documentation: How We Built an AI Tutorial Validator
2+
3+
> If you're in a hurry and want to quickly check the repository, you can find the source code of the AI Tutorial Validator here 👉 [github.com/abpframework/ai-tutorial-validator](https://github.com/abpframework/ai-tutorial-validator)
24
35
Writing a tutorial is difficult. Keeping technical documentation accurate over time is even harder.
46
If you maintain developer documentation, you probably know the problem: a tutorial that worked a few months ago can silently break after a framework update, dependency change, or a small missing line in a code snippet.
@@ -34,7 +36,7 @@ It treats tutorials like testable workflows, ensuring that every step works exac
3436

3537
## How the Tutorial Validator Works?
3638

37-
the tutorial validator validates tutorials using a three-stage pipeline:
39+
The tutorial validator validates tutorials using a three-stage pipeline:
3840

3941
1. **Analyst**: Scrapes tutorial pages and converts instructions into a structured test plan
4042
2. **Executor**: Follows the plan step by step in a clean environment
@@ -43,7 +45,7 @@ the tutorial validator validates tutorials using a three-stage pipeline:
4345
![the tutorial validator Analyst](docs/images/image-1.png)
4446

4547
It identifies commands, code edits, HTTP requests, and expected outcomes.
46-
The key idea is simple: if a developer would need to do it, the validator does it too.
48+
The key idea is simple: if a developer needs to do it, the validator does it too.
4749
That includes running terminal commands, editing files, checking HTTP responses, and validating build outcomes.
4850

4951
![the tutorial validator Executor](docs/images/image-2.png)
@@ -108,6 +110,6 @@ If your team maintains technical tutorials, this project can give you a practica
108110

109111
---
110112

111-
You can find the source-code of the tutorial validator at this repo 👉 https://github.com/abpframework/tutorial-validator
113+
You can find the source code of the tutorial validator at this repo 👉 [github.com/abpframework/ai-tutorial-validator](https://github.com/abpframework/ai-tutorial-validator)
112114

113115
We would love to hear your feedback, ideas and waiting PRs to improve this application.

0 commit comments

Comments
 (0)