Skip to content

Commit 9785e64

Browse files
committed
Add documentation quality workflow
1 parent 2351be2 commit 9785e64

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

.github/workflows/docs-check.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Documentation Quality Check
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
docs-check:
9+
name: Validate documentation files
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v4
15+
16+
- name: Check required documentation files
17+
run: |
18+
test -f README.md
19+
test -f package.json
20+
21+
- name: Check for JSDoc comments in utility files
22+
run: |
23+
grep -R "@param" . --include="*.js"
24+
grep -R "@returns" . --include="*.js"
25+
26+
- name: Check for TODO placeholders in documentation
27+
run: |
28+
! grep -R "TODO: documentation" README.md *.js

0 commit comments

Comments
 (0)