Repository navigation
Commit 34842da
authored
fix(rsr-verify): accept .adoc — the docs exist, the check named .md (#194)
`rsr-verify.sh` fails 7 documentation checks in a plugin whose
documentation **is complete**.
```
checks for: docs/ARCHITECTURE.md docs/API_REFERENCE.md docs/FAQ.md
docs/QUICKSTART.md docs/TROUBLESHOOTING.md
docs/EXAMPLES.md docs/MIGRATION.md
on disk: docs/ARCHITECTURE.adoc docs/API_REFERENCE.adoc docs/FAQ.adoc
docs/QUICKSTART.adoc docs/TROUBLESHOOTING.adoc
docs/EXAMPLES.adoc docs/MIGRATION.adoc
(plus CITATIONS.adoc and COMPATIBILITY.adoc)
```
Every document exists. The `.md` → `.adoc` migration moved them and left
the verifier naming the old extension, so **7 of the RSR compliance
checks have been failing on a compliant plugin**.
## Fix
Accept either extension — the same pattern the RSR template's own
`quality.yml` already uses for README, LICENSE and CONTRIBUTING:
```bash
check "ARCHITECTURE exists" "[[ -f docs/ARCHITECTURE.md ]] || [[ -f docs/ARCHITECTURE.adoc ]]"
```
The check label drops the extension too, so a failure message names the
*document* rather than a filename that may be either form.
## Verified
| | |
|---|---|
| checks satisfied against files actually on disk | **7 / 7** |
| still missing | **0** |
| `shellcheck -S error` | **0 findings** |
## Provenance
Found by an estate-wide sweep of 5,111 scripts across 375 repos. Same
defect class as the 56 unsatisfiable checks repointed across 18 repos
earlier in this campaign (see hyperpolymath/Axiom.jl#82).
⚠ I initially filed these as *missing documentation* in
hyperpolymath/standards#653 and was about to author 14 replacement
files. That was wrong — my classifier looked for the `.adoc` twin at the
**repo root**, but these live at `asdf-ghjk/docs/`, so it reported no
twin. Issue #653 is being corrected.1 parent fa1d4d2 commit 34842da
1 file changed
Lines changed: 7 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
75 | | - | |
76 | | - | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
| |||
0 commit comments