Repository navigation
feat: extract configurable executable documentation framework - #6
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.
N3's executable documentation harness currently owns document composition and publication inside its application replay. This extracts a reusable Rust SDK and keeps N3's existing published guide byte-for-byte compatible.
Changes
executable-docsSDK for Rust-authored prose, checked observations, frozen resources, typed references, and contributor notes. Reader and Contributor exports reuse one execution.Validation
just verifythrough the pre-push hook: formatting, workspace Clippy, tooling, SDK/consumer tests, doctests, strict API docs, N3 tests with exact guide replay, and measurement checks.The SDK/API and manifest remain experimental and unpublished. Markdown is the current complete exporter; independent developer adoption, alternate publishers, and Git/diff views remain future work. Windows inventory separators are corrected, but Windows runtime validation has not been performed.