/docs

Underware Games Docs

Dev Notes

• This is a Vocs project bootstrapped with the Vocs CLI.
• Read the MDX specification
• Get the MDX extension for Visual Studio Code
• Get the MDX Preview extension for Visual Studio Code
• Enable MDX preview on VS Code by clicking the 🔎 on the top right corner.
• Enable Markdown preview on VS Code by clicking the 🔎 or pressing ⌘K+V

Toolchain and verification

The reviewed local toolchain is pinned in .node-version and the integrity- qualified packageManager field in package.json. Use Corepack so an unrelated global pnpm installation cannot bypass that pin:

nvm install
nvm use
corepack pnpm install
corepack pnpm run deps:audit
corepack pnpm run verify
corepack pnpm ignored-builds

pnpm install is frozen by repository policy and therefore cannot rewrite the reviewed lockfile. Use --no-frozen-lockfile only while preparing an explicitly reviewed dependency change; commit its dependency-review record with the resulting manifest and lockfile changes.

Dependency versions, the lockfile, Node.js, pnpm, install-script allowances, and executable CI actions may change only with a completed record in docs/dependency-reviews/. See that directory's README for the required candidate review, advisory assessment, provenance checks, and verification.

Run the governed advisory gate with corepack pnpm run deps:audit. CI rejects every unreviewed finding; the two visible image-size advisories are accepted only for the exact locally patched version and are covered by timeout-based regression probes. See the current dependency-review record for the owner and re-review deadline.

Styling

• About Vocs styling, theming
• Make use of Tailwind CSS styling, ex: font size