Introduction
What zudo-sg is, what it produces, and where each public site lives.
What zudo-sg is
zudo-sg is a style-guide framework built on zudo-doc. It combines a zfb static site, zudo-wind utility CSS, zudo-react components, and a shared component package into a workspace for designing, documenting, and testing a target website UI system. Its catalog, preview, and token machinery ship as an installable package, @takazudo/zudo-sg (packages/styleguide) — a project adopts it the way it adopts @takazudo/zudo-doc itself, rather than copying application code.
This documentation site is contributor-facing: it explains how this repository's workspace is arranged, how component stories become catalog pages, how design tokens are managed, how the engine package is built and composed, and which checks keep the system stable. It is deployed separately from the public styleguide (https: versus https:), with no navigation between the two sites and no shared build — they are two independent products, not one product shown from two angles.
New projects can start with the pnpm-only create-zudo-sg initializer; it creates a small host that uses the published @takazudo/zudo-sg engine. The Installation page shows that quick path, while the root site's Adopting the engine page keeps the complete manual setup for existing hosts.
The workspace outputs
The monorepo produces five main artifacts:
Root styleguide host: the zudo-doc based catalog deployed at
https:, dogfooding the engine package below./ / zudo- sg. takazudomodular. com/ packages/styleguide(@takazudo/zudo-sg): the installable styleguide engine — story registry/scaffold/token-manifest CLI, catalog/detail/preview/tokens routes, preview app, code panel, and token dashboards.packages/create-zudo-sg(create-zudo-sg): the pnpm-only initializer that scaffolds a private host around the engine.packages/demo-ui: the shared zudo-react component library and design-token source of truth, consumed directly from source.apps/demo: a static demo site deployed athttps:./ / zudo- sg- demo- site. takazudomodular. com/
The / workspace (this site) is a separate zudo-doc site for project documentation. It documents the framework and the engine without being the styleguide itself.
What to read next
Use Installation to get the workspace running. Then read Monorepo Layout, Component Catalog Pipeline, and Quality Gates to understand how changes move from source files to checked output.