Publish searchable, revision-aware documentation - #120
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.
Change
Build a searchable DocFX site from the existing Markdown, with concise navigation and links to each page's source. Documentation links remain relative under any site base path; links to repository files resolve to the exact build commit, so previews and older releases do not drift to
main. Generated output stays untracked and the temporary foundation plan is excluded.Both selected Ubuntu PR lanes validate the rendered site through the required
build-testgate. A separate manual workflow rebuilds protectedmainand publishes its checked artifact through the main-only, reviewer-protectedgithub-pagesenvironment. Pages is configured for GitHub Actions with HTTPS. Actual deployment and hosted browser acceptance follow this merge and will be recorded separately.Validation
pwsh ./scripts/check.ps1 full -Serial: required solution, content/policy, frontend packaging, and isolated shell gates.pwsh ./scripts/check-docs.ps1: 27 pages, rendered local links and anchors, search/source-link inventory, and four deliberate-defect regression groups, including two source revisions and relative page links.Section 17's engine example/API reference remains open until the first engine slice exists. Existing uncommitted section 16 browser-testing work is excluded.
AI assistance was used for implementation, tests, documentation, and independent code inspection. Local automated checks are distinct from the forthcoming hosted deployment and browser checks.