File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 77 branches : [main]
88
99jobs :
10- documentation-quality :
10+ documentation-structure :
1111 runs-on : ubuntu-latest
1212
1313 steps :
1414 - uses : actions/checkout@v4
1515
16- - name : Set up Node.js
17- uses : actions/setup-node@v4
18- with :
19- node-version : " 20"
20-
21- - name : Install dependencies
22- run : |
23- npm install -g markdownlint-cli @mermaid-js/mermaid-cli
24-
25- - name : Lint markdown files
26- run : |
27- markdownlint docs/**/*.md README.md CLAUDE.md
28-
29- - name : Validate Mermaid diagrams
30- run : |
31- ./scripts/validate-mermaid.sh
32-
3316 - name : Check documentation structure
3417 run : |
3518 # Verify required documentation files exist
36- test -f docs/quickstart.md || echo "Warning: docs/quickstart.md missing"
37- test -f docs/architecture.md || echo "Warning: docs/architecture.md missing"
38- test -f docs/tutorial.md || echo "Warning: docs/tutorial.md missing"
39- test -f docs/api-reference.md || echo "Warning: docs/api-reference.md missing"
19+ test -f docs/quickstart.md || { echo "Error: docs/quickstart.md missing"; exit 1; }
20+ test -f docs/architecture.md || { echo "Error: docs/architecture.md missing"; exit 1; }
21+ test -f docs/tutorial.md || { echo "Error: docs/tutorial.md missing"; exit 1; }
22+ test -f docs/api-reference.md || { echo "Error: docs/api-reference.md missing"; exit 1; }
23+ echo "All required documentation files present"
You can’t perform that action at this time.
0 commit comments