docs: a VitePress developer site over the design record - #8
Open
HalfSweet wants to merge 7 commits into
Open
Conversation
bun-run scripts (docs:dev / docs:build / docs:preview), and the generated .vitepress cache and dist stay out of commits the same way dist/ does.
The config is .mts on purpose: this package declares no "type": "module" and vitepress is ESM-only, so a .ts config dies in esbuild's require path. The theme layers over the default one with no component overrides: the grass-green palette, the hero gradient, screenshot and pipeline styling, and two mermaid rules earned the hard way — .vp-doc typography must not leak into HTML labels (it inflates them past the boxes mermaid measured), and the dark theme's translucent .labelBkg is replaced by one page-background caption per edge label.
Hero gradient over a glowing PSP capture, stat badges, feature cards that link into the guide, and the cook/run pipeline as a two-panel HTML diagram hinged on the pak node — no ascii.
Seven pages — getting started, architecture, asset pipeline, quality ladder, PSP, Vita, testing & determinism — distilled from VOXEL.md, SCHEMA.md and tools/voxel.ts rather than restated from the README, with mermaid diagrams where the record drew boxes. Where the record disagrees with itself (§2/§6/§9 still say 20-byte vertices; §7's ceremony and §12's PakVert are the v8 16-byte format), these pages follow the newest state.
The byte-layout truth stays in contracts/spec/voxel-spec.ts and voxelmon/SCHEMA.md; these pages summarize and link instead of forking it. The glossary carries the project's invented vocabulary — rung, dial, tape, ceremony — which is the page a new reader needs first.
The six rules a PR can break without noticing: the content boundary, the identity anchor, the no-moving-boundary rule, the 24 px cull invariant, formula provenance, and the spec codegen ceremony.
Push-to-main on docs paths, or by hand. The build needs no submodules, no ROM and no reference checkouts; Pages must be set to "GitHub Actions" once in the repo settings.
HalfSweet
marked this pull request as ready for review
August 11, 2026 14:58
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.
What this is
A developer-facing docs site under
docs/, built with VitePress. It is areadable layer over the existing record, not a rewrite:
docs/VOXEL.mdis untouched and joins the nav as the Design Record; the byte-layout truth
stays in
contracts/spec/voxel-spec.tsandvoxelmon/SCHEMA.md, and the newpages summarize and link instead of forking facts.
Contents
an HTML two-panel diagram hinged on the pak node.
quality ladder, PSP, Vita, testing & determinism. Distilled from VOXEL.md,
SCHEMA.md and
tools/voxel.ts(not restated from the README), with mermaiddiagrams where the record drew ascii boxes.
tools/voxel.tscommands, the surface opvocabulary, data & formats (
.tape/.vtrace/ VXPK sections), and aglossary of the project's invented vocabulary.
identity anchor, no-moving-boundary, the 24 px cull invariant, formula
provenance, spec codegen). Two items are newly codified rather than quoted
from the record: the "golden accounting goes in the PR" convention, and the
docs-layering rule itself.
.github/workflows/docs.ymldeploys to GitHub Pages on push tomain (docs paths). Needs Pages → Source: "GitHub Actions" set once; the
build needs no submodules, no ROM, no reference checkouts.
Decisions worth reviewing
the 16-byte v8 vertex (§7 ceremony, §12 PakVert) rather than the stale
20-byte wording of §2/§6/§9. Pak-size figures are deliberately not restated
anywhere.
config.mtsbecause the package declares no"type": "module"and vitepress is ESM-only.theme CSS keeps
.vp-doctypography from leaking into diagram labels.Try it