Repository navigation
feat(docs): pilot README and documentation quality checks - #37
Merged
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.
README structure and navigation checks now enforce the documentation pilot in QoraGeom and QoraPhase, while other repositories receive non-failing warnings. Reasoned exemptions use the existing
.conventions.tomlmechanism. CONVENTIONS defines the 200-line first screen and the documentation layout.The shared README workflow also runs marked Markdown blocks recursively under
docs/on Ubuntu. Existing README platform coverage stays unchanged. The local CI runner executes documentation examples on Linux and explicitly reports them as not run on other hosts. Malformed marked fences fail immediately instead of hanging. Blocks stop at the first failed shell or native PowerShell command; the runner requires PowerShell 7.3 or later.Fixes #36.
Fixes #38.
Validation:
The full local record reports the unrun second matrix combination and that Ubuntu jobs ran on a Windows host. Ubuntu workflow execution and hosted Actions were not tested locally. The reusable workflow is consumed from main, so downstream CI receives these checks after this change is integrated. No consumer repository, release or installed tool was changed.