From 424c7dffc95f2c22b2210d87819e30cab7c7e1f2 Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Wed, 26 Aug 2026 20:30:59 +0100 Subject: [PATCH] =?UTF-8?q?fix(rsr-verify):=20accept=20.adoc=20=E2=80=94?= =?UTF-8?q?=20the=20docs=20exist,=20the=20check=20named=20.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit rsr-verify.sh fails 7 documentation checks in a plugin whose documentation is COMPLETE. It checks docs/ARCHITECTURE.md, API_REFERENCE.md, FAQ.md, QUICKSTART.md, TROUBLESHOOTING.md, EXAMPLES.md and MIGRATION.md; the plugin ships all seven as .adoc, plus CITATIONS.adoc and COMPATIBILITY.adoc. The .md -> .adoc migration moved the documents and left the verifier naming the old extension, so seven RSR compliance checks have been failing on a compliant plugin. Fixed by accepting either extension - the same pattern the RSR template's own quality.yml uses for README, LICENSE and CONTRIBUTING. The check label drops the extension too, so a failure names the document rather than a filename that may legitimately be either form. Verified: 7/7 checks satisfied against the files actually on disk, 0 missing, shellcheck -S error reports 0 findings. ⚠ I first 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/. Issue #653 is being corrected. --- asdf-augmenters/asdf-ghjk/scripts/rsr-verify.sh | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/asdf-augmenters/asdf-ghjk/scripts/rsr-verify.sh b/asdf-augmenters/asdf-ghjk/scripts/rsr-verify.sh index b88b582a..f20fa8e3 100755 --- a/asdf-augmenters/asdf-ghjk/scripts/rsr-verify.sh +++ b/asdf-augmenters/asdf-ghjk/scripts/rsr-verify.sh @@ -67,13 +67,13 @@ check "CODE_OF_CONDUCT.md exists" "[[ -f CODE_OF_CONDUCT.md ]]" check "MAINTAINERS exists" "[[ -f MAINTAINERS.adoc ]]" check "SECURITY.md exists" "[[ -f SECURITY.md ]]" check "CHANGELOG exists" "[[ -f CHANGELOG.adoc ]]" -check "ARCHITECTURE.md exists" "[[ -f docs/ARCHITECTURE.md ]]" -check "API_REFERENCE.md exists" "[[ -f docs/API_REFERENCE.md ]]" -check "FAQ.md exists" "[[ -f docs/FAQ.md ]]" -check "QUICKSTART.md exists" "[[ -f docs/QUICKSTART.md ]]" -check "TROUBLESHOOTING.md exists" "[[ -f docs/TROUBLESHOOTING.md ]]" -check "EXAMPLES.md exists" "[[ -f docs/EXAMPLES.md ]]" -check "MIGRATION.md exists" "[[ -f docs/MIGRATION.md ]]" +check "ARCHITECTURE exists" "[[ -f docs/ARCHITECTURE.md ]] || [[ -f docs/ARCHITECTURE.adoc ]]" +check "API_REFERENCE exists" "[[ -f docs/API_REFERENCE.md ]] || [[ -f docs/API_REFERENCE.adoc ]]" +check "FAQ exists" "[[ -f docs/FAQ.md ]] || [[ -f docs/FAQ.adoc ]]" +check "QUICKSTART exists" "[[ -f docs/QUICKSTART.md ]] || [[ -f docs/QUICKSTART.adoc ]]" +check "TROUBLESHOOTING exists" "[[ -f docs/TROUBLESHOOTING.md ]] || [[ -f docs/TROUBLESHOOTING.adoc ]]" +check "EXAMPLES exists" "[[ -f docs/EXAMPLES.md ]] || [[ -f docs/EXAMPLES.adoc ]]" +check "MIGRATION exists" "[[ -f docs/MIGRATION.md ]] || [[ -f docs/MIGRATION.adoc ]]" # ============================================================================= # Category 2: Licensing