Skip to content

Commit b0edaa8

Browse files
committed
Add Guide Format Validator: Introduce configuration file, installation script, and validation scripts. Implement rule-based and LLM validation methods, enhance documentation with usage examples, and provide manual validation instructions. Include example guides for both good and bad formatting.
1 parent acdffbc commit b0edaa8

21 files changed

+8
-8
lines changed

guide-format-validator/README.md renamed to guide-validator/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A simple validation tool for markdown guide files that ensures compliance with d
1818

1919
1. **Install:**
2020
```bash
21-
cd guide-format-validator
21+
cd guide-validator
2222
./install.sh
2323
```
2424

@@ -45,7 +45,7 @@ A simple validation tool for markdown guide files that ensures compliance with d
4545
$ ./validate /path/to/guide.md
4646

4747
🔍 Validating: /path/to/guide.md
48-
📁 Using prompts from: /path/to/guide-format-validator/prompts
48+
📁 Using prompts from: /path/to/guide-validator/prompts
4949

5050
# Guide Validation Results
5151
**File:** /path/to/guide.md
@@ -340,11 +340,11 @@ jobs:
340340
python-version: '3.11'
341341
- name: Install dependencies
342342
run: |
343-
cd guide-format-validator
343+
cd guide-validator
344344
pip install -r requirements.txt
345345
- name: Validate guides
346346
run: |
347-
cd guide-format-validator
347+
cd guide-validator
348348
python3 scripts/validate_guides.py docs/guides/my-guide.md
349349
```
350350

@@ -356,10 +356,10 @@ repos:
356356
hooks:
357357
- id: validate-guides
358358
name: Validate Guide Format
359-
entry: python3 guide-format-validator/scripts/validate_guides.py
359+
entry: python3 guide-validator/scripts/validate_guides.py
360360
language: system
361361
files: \.md$
362-
args: [--config, guide-format-validator/config.yaml]
362+
args: [--config, guide-validator/config.yaml]
363363
```
364364

365365
## Adding New Validators
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)