-
Notifications
You must be signed in to change notification settings - Fork 1
43 lines (36 loc) · 1.58 KB
/
Copy pathdocs-quality-check.yml
File metadata and controls
43 lines (36 loc) · 1.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
name: Documentation Quality Check
on:
pull_request:
paths:
- 'projects/*/docs/**'
permissions:
contents: read
pull-requests: write
jobs:
quality-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
submodules: recursive
- name: Copilot Code Review
uses: github/copilot-code-review-action@v1
with:
model: claude-sonnet-4
custom-instructions: |
You are reviewing documentation changes for an open-source project.
The documentation is written in MDX (Fumadocs framework).
CRITICAL: Cross-reference every technical claim in the documentation
against the actual source code in this repository:
- API endpoints: verify against internal/api/routes.go
- Environment variables: verify against internal/config/config.go or main.go
- Response formats: verify against internal/models/models.go
- Feature descriptions: verify against the actual handler code
- CLI commands: verify against Makefile, package.json, or go.mod
Flag any documentation that:
1. Describes an endpoint that doesn't exist in routes.go
2. Shows a wrong default value for an environment variable
3. Uses incorrect command syntax
4. Describes a feature that doesn't match the implementation
5. Is written too technically for HomeLab beginners
Provide specific file:line references when pointing out discrepancies.