zudo-circuit-doc

Type to search...

to open search from anywhere

The generated project

The exhaustive file-by-file layout of a generated project, and every root script.

This is the exhaustive version of Getting Started → What you get.

Root files

FilePurpose
package.jsonprivate: true, "type": "module", packageManager pinned to pnpm@11.5.2
pnpm-workspace.yamlpackages: [doc], minimumReleaseAge: 0, allowBuilds.esbuild, and any required trustPolicyExclude setting
circuit.config.tsSee Reference → circuit.config.ts
README.mdCommands, the first circuit task, tool requirements
CLAUDE.md, AGENTS.mdThin pointers to circuit/WORKFLOW.md, written per --agent
.gitignoreIncludes .circuit-cache/
ZUDO_DEPS_PINS.mdProvenance for the vendored zudo-doc scaffold — see Concepts → Ownership and upgrades

circuit/

PathPurpose
WORKFLOW.mdThe canonical workflows A–G — see Workflows
agent-task-examples.mdNine short example requests, English + Japanese
templates/The 10 unpublished authoring templates, plus the CAD asset receipt template (.json and .md)
checks/README.mdWhat each check establishes, and what it doesn't
publication/selection.json, publication/assets.jsonEmpty at scaffold time — see Publication schemas
generated/preflight.jsonThe generated preflight report
cad-receipts/Created when the first CAD asset is acquired (not present at scaffold time)

.claude/skills/

PathPurpose
component-spec-audit/SKILL.mdOwner-audit skill entry
component-spec-audit/references/inventory.jsonExplicitly empty at scaffold time
component-spec-audit/references/direct-routing.json, external-vendor-qualifiers.jsonRouting configuration
component-spec-audit/references/new-component-workflow.mdThe step-by-step checklist Workflow B follows
circuit-spec-integration/SKILL.mdCross-component integration skill entry
circuit-spec-integration/references/rules.json{ "schema_version": 1, "rules": [] } at scaffold time
component-<suffix>/One owner bundle per exact component, created by new-component — see Concepts → The evidence contract

doc/ (the zudo-doc app)

PathPurpose
pages/docs/[[...slug]].tsx, pages/index.tsxThe host route stub, with the islands seed import added
pages/lib/_circuit-doc-islands.tsSide-effect import of @takazudo/zudo-circuit-doc/islands
src/chrome-bindings.tsxSpreads circuitDocMdxExtras into the host's MDX component set
src/styles/global.cssImports the package's styles.css after zudo-doc's own CSS
zfb.config.tsclaudeResources { claudeDir: "../.claude", scanRoot: ".." }, docHistoryExclude ["components", "components/**"], defaultLocaleOnlyPrefixes for /docs/components/ and /docs/claude*/, themePacks: ["default"], dynamicPageTransition, llmsTxt, strictContentBridge
src/content/docs/{project,architecture,research,decisions,verification}/Authored — yours to write
src/content/docs/components/**Generated — never hand-edited
public/assets/component-previews/**Generated footprint SVGs and published WRL models

Not generated: boards/, symbols/, footprints/, manufacturing/, any LED-specific value, or deploy configuration of any kind.

Root scripts

ScriptRuns
pnpm devpnpm --dir doc dev
pnpm buildzudo-circuit-doc models && zudo-circuit-doc generate && pnpm --dir doc build
pnpm checkzudo-circuit-doc check && pnpm --dir doc check
pnpm circuit:checkzudo-circuit-doc validate
pnpm circuit:generatezudo-circuit-doc generate
pnpm circuit:doctorzudo-circuit-doc doctor
pnpm check:sitezudo-circuit-doc check-built && zudo-circuit-doc scan && pnpm --dir doc check:links -- --strict-anchors --strict-broken
pnpm previews:generatezudo-circuit-doc footprints generate (optional; needs Docker)

Revision History

CreatedUpdated