fix(docs): use content-addressed manual provenance - #79
Merged
Conversation
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
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
The documentation-sync check coupled the identity of the current manual
artifacts to a manually recorded historical Git commit.
Legitimate updates to the manual could therefore make the recorded commit
stale even when the committed artifacts were internally consistent. Updating
the commit hash would only postpone the same failure.
Resolution
This PR replaces the historical-commit invariant with deterministic,
content-addressed provenance.
The committed manifest records, for each published manual artifact:
Covered artifacts:
docs/user-guide.mddocs/user-guide.texdocs/user-guide.pdfscripts/update_manual_provenance.pyprovides:--writefor explicit deterministic regeneration;--checkfor read-only CI verification.The manifest is canonical UTF-8 JSON with LF termination and contains no
timestamps, usernames, absolute paths, cache paths, temporary paths, branch
names, or manually maintained Git commit hashes.
CI behavior
check_docs_sync.pynow verifies the committed files against the manifest.The check still fails on missing, modified, stale, malformed, or unexpected
artifacts.
Git history is no longer required, so full-history checkout was removed from
the documentation workflow.
Verification
--writeoutput byte-identical;--checkconfirmed non-mutating;Scope
This proves exact artifact identity only. It does not claim semantic
correctness or reproducible PDF generation.
No scientific algorithms, numerical fixtures, APIs, validation thresholds,
or maturity claims are changed.