Add the documentation site foundation (T11) - #130
Merged
Merged
Conversation
The repository has no Pages site, so issue #114's documentation work has nothing to build on. This change adds the site skeleton, two pages, one cross-platform strict build command, and a docs-only Pages workflow. - mkdocs.yml derives the site URL from the repository owner and name, keeps a two-page nav, offers light and dark palettes, and fails the build on an unlisted page or an unresolvable link or image. - docs/index.md and docs/getting-started.md state only claims verified against main: the unity 2021.3 floor, the Tools > Wallstop Studios > Data Visualizer menu path, the panel and Play Mode behavior, and the free-forever terms. - scripts/build-docs.ps1 installs the pinned requirements into a gitignored .docs-venv and runs mkdocs build --strict; -Serve previews locally. The workflow calls the same script. - The Pages workflow builds on pull requests and on main, uploads the built site as a run artifact, and deploys only when the repository has Pages enabled; until then it warns instead of failing the run. Validation: strict build green with 3 pages; red on a missing page link, a missing image, and an unlisted page; actionlint 1.7.7 clean; lint ladder green with 18/18 self-test files; npm pack payload unchanged at 172 files; the release .unitypackage still builds and validates with 92 entries. Refs #114, T11. Pages is not enabled for this repository, so no live URL is claimed and the README does not link to the site yet.
This was referenced Oct 2, 2026
The pages stated the package's minimum Unity version as if it were a tested floor. The window is developed and tested on Unity 6, and the 2021.3 editor is not part of the local validation, which #86 tracks. The pages now say so and link the issue.
The workflow guarded its deploy job with a GitHub Pages API check that warns instead of failing when Pages is off. Probing the API shows the guard can never fire: the repository already has a Pages site whose source is GitHub Actions, at https://wallstop.github.io/DataVisualizer/, with no build and no deployment in its history. The 404 is only the absence of a first publish. The guard is therefore dead code that hides the real state. The deploy job now runs on every push to main that touches documentation, which is what the roadmap asks for, and the first merge of the site publishes it.
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.
The repository has no documentation site, so #114's documentation work has no foundation. This adds the site skeleton, two pages, one strict local build command, and a docs-only Pages workflow.
Behavior
mkdocs.ymlderives the site URL from the repository owner and name, keeps a two-page nav with light and dark palettes, and fails the build on an unlisted page or an unresolvable link or image.scripts/build-docs.ps1builds it strictly from a pinnedrequirements-docs.txt, and the workflow calls the same script.main, then deploys on everymainpush that touches documentation. Pages is configured with the GitHub Actions source and has no deployment yet, so the first merge publishes the site. Two pages only, and no imagery until chore: Documentation OverHaul + Auto-Captured Images/webp #114's capture render gap is fixed, so the README does not link to the site yet.Validation
-Servepreviews at the configured site path.actionlint1.7.7 clean.npm run lint:llm:fullgreen (18/18 self-test files);npm packpayload unchanged at 172 files; the release.unitypackagestill builds and validates with 92 entries. No C# or Unity change, so the Unity suites are not exercised.Risk / Rollback
mainrun attempts the repository's first Pages deployment.Refs #114, T11. The pre-existing CSharpier gate failure found while validating is #129.