UNPKG

paqad-ai

Version:

Spec-driven development framework — AI agents that think before they type

github.com/Eliyce/paqad-ai

Eliyce/paqad-ai

49 lines (34 loc) • 2.17 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
44
45
46
47
48
49
--- name: diff-doc-sync description: 'Lists only the canonical docs the current diff made stale. Use when implementation or validation is done, the changed files are known, and only the stale doc set is needed.' metadata: model_tier: fast cacheable: 'true' output_format: json paqad-meta: skill.meta.yaml --- ## What It Does Narrows documentation follow-up to only the canonical docs made stale by the current diff, avoiding full documentation refreshes when `differential_refresh` is enabled. ## Use This When After implementation or validation when you already know which files changed and only want the stale canonical documentation set. ## Inputs - Read the changed file list from `changed_files`. Fill it from the `Changed files` list in the header of `.paqad/session/review-digest.md` (run `paqad-ai review digest` to refresh it), or straight from git: `git status --porcelain` plus `git diff --name-only $(git merge-base HEAD main)..HEAD`. - Read `references/diff-sync-rules.md` for project-specific override rules before deciding whether a doc can be safely skipped. ## Procedure 1. Pipe the changed file list into `scripts/detect-stale-docs.sh`: it cross-references against existing canonical docs and emits candidate paths. 2. Drop any paths that `references/diff-sync-rules.md` declares safe to skip in this scenario. 3. Format as a JSON array exactly matching `assets/output.template.json` (sorted, duplicate-free). 4. Validate with `scripts/lint-output.sh`: it enforces JSON shape, sortedness, dedupe, and `.md` suffix. ## Output Contract - Match `assets/output.template.json`: a JSON array of canonical doc paths. `[]` exactly when none are stale. - Output must pass `scripts/lint-output.sh` (exit 0). ## Escalate / Stop Conditions - Ask when the changed file list is missing or incomplete. - Warn when the stale doc detector is unavailable or returns non-canonical paths. - Do not widen the result to a full documentation workflow unless the detector evidence requires it. ## Resources - `references/diff-sync-rules.md` - `scripts/detect-stale-docs.sh` - `scripts/lint-output.sh` - `assets/output.template.json` - `agents/openai.yaml`