fix(docs): README back-links + real LICENSE section (unblocks 2 red CI gates)#677
Merged
Merged
Conversation
…I gates) README failed two CI doc-governance gates in .github/workflows/ci.yml: 1. tools/check-soundness-ledger.sh (property 2, back-links): README pointed at `SOUNDNESS-LEDGER.adoc` — a filename that does not exist. The gate greps for `SOUNDNESS.adoc`; the old string did not match -> RED. 2. tools/check-doc-truthing.sh (DOC-04): README did not mention the authoritative status matrix `CAPABILITY-MATRIX.adoc` anywhere -> RED. Fixes, all in README.adoc: - repoint the 3 soundness-ledger references to `docs/SOUNDNESS.adoc` - add `docs/CAPABILITY-MATRIX.adoc` (feature readiness) in Status + Documentation - replace the stale "state the license and add a LICENSE file" TODO with a real License section (LICENSE + LICENSES/ already exist: MPL-2.0 code, CC-BY-SA-4.0 docs) Supersedes #675 (which fixed only the soundness link). Verified (dune 3.24.0, system OCaml 4.14.1 + opam switch as-verify): BUILD_EXIT=0 OK: doc-truthing intact (TRUTH_EXIT=0) OK: soundness ledger — all 5 properties hold (GATE_EXIT=0) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
README failed two CI doc-governance gates (both in
.github/workflows/ci.yml):check-soundness-ledger.sh(property 2, back-links) — README pointed atSOUNDNESS-LEDGER.adoc, a filename that does not exist. The gate greps forSOUNDNESS.adoc; the old string didn't match → RED.check-doc-truthing.sh(DOC-04) — README did not mention the authoritative status matrixCAPABILITY-MATRIX.adocanywhere → RED.Both were pre-existing reds on
main(verified against pristineorigin/main).Fix (README.adoc only)
docs/SOUNDNESS.adocdocs/CAPABILITY-MATRIX.adoc(feature readiness) in Status + DocumentationLICENSE+LICENSES/already exist: MPL-2.0 code, CC-BY-SA-4.0 docs)Verification (real toolchain — dune 3.24.0, OCaml 4.14.1 + opam)
Supersedes #675
#675 fixed only the soundness link, so it could not turn the doc-truthing gate green on its own (that gate is required, so #675 was unmergeable alone). This PR fixes both. #675 will be closed as superseded. Also unblocks the descriptiles migration #676 (blocked only by these same README gates).
🤖 Generated with Claude Code