You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/Community-Articles/2026-03-10-Tutorial-Validator/article.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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)
2
4
3
5
Writing a tutorial is difficult. Keeping technical documentation accurate over time is even harder.
4
6
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
34
36
35
37
## How the Tutorial Validator Works?
36
38
37
-
the tutorial validator validates tutorials using a three-stage pipeline:
39
+
The tutorial validator validates tutorials using a three-stage pipeline:
38
40
39
41
1.**Analyst**: Scrapes tutorial pages and converts instructions into a structured test plan
40
42
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:
@@ -108,6 +110,6 @@ If your team maintains technical tutorials, this project can give you a practica
108
110
109
111
---
110
112
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/tutorial-validator](https://github.com/abpframework/ai-tutorial-validator)
112
114
113
115
We would love to hear your feedback, ideas and waiting PRs to improve this application.
0 commit comments