Zudo Sg Docs

Type to search...

to open search from anywhere

Package-Owned Doc Scaffold

Why the docs workspace keeps only canonical route stubs and relies on zudo-doc for scaffold behavior.

Minimal local surface

The docs workspace uses zudo-doc's single-entry configuration and package-owned scaffold. Its local runtime surface is deliberately small:

  • doc/zfb.config.ts records only project choices passed to zudoDoc().

  • doc/pages/index.tsx re-exports the package home route.

  • doc/pages/docs/[[...slug]].tsx reconstructs the docs catch-all through sanctioned package and virtual-module entrypoints so dynamic docs work in both development and production builds.

  • doc/src/styles/global.css establishes the scaffold layer order and imports package styles.

There is no local pages/lib chain and no placeholder component island set. Navigation, route context, chrome, content components, schema defaults, translations, color schemes, and enabled feature islands come from @takazudo/zudo-doc.

Adding behavior

Prefer a supported zudoDoc() setting or package export before adding project code. A genuinely project-specific route or interactive island may still be local, but it must be reachable through a static page import and must not duplicate package defaults.

Features that are disabled in zfb.config.ts should remain absent rather than represented by no-op files. This keeps dependency reachability and generated island markers aligned with the features that actually ship.

Reference

zudolab/zudo-doc is the upstream framework repository and the authority for the canonical scaffold contract.