Docs overhaul: automated screenshots, new theme, new pages - #25
Merged
Conversation
…Hero/Footer/Pagination components, a rehype-sections plugin, and mermaid diagram support styled from the house tokens.
… workflow and the screenshot harness share one lockfile instead of separate requirements files.
…d regenerates every docs screenshot from a manifest, so shots stop drifting from the app as it changes.
…hand-captured ones, so the naming matches the manifest and the shots match the current app.
…dd pages for the features that had none: users and permissions, device adoption, e-stop, cloud, assistant, control surfaces, VNC, ATEM SuperSource, and a show network design guide.
…n CI, and add a local smoke test plus pre-push hook so broken links get caught before they reach a PR. The hook body lives in scripts/ so it survives a fresh clone; .git/hooks/pre-push is a shim that execs 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
1 participant
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 software docs had drifted from the app — screenshots were hand-captured and stale, and several shipped features had no page at all. This rewrites the sndwrks Local docs against the current app and adds pages for users and permissions, device adoption, e-stop, cloud, assistant, control surfaces, VNC, ATEM SuperSource, plus a show network design guide.
To stop the drift, screenshots are now generated by a Playwright harness (
scripts/screenshots/) that drives a live instance from a manifest, so a shot can be re-taken instead of re-staged by hand. All 60+ images are regenerated and renamed to match the manifest; the Python scripts moved to uv dependency groups so the harness and the llms.txt workflow share one lockfile.Also reworks the site theme — purple accent, Catppuccin code blocks, custom Hero/Footer/Pagination components, and mermaid diagram support styled from the house tokens.
npm run buildpasses, 32 pages.