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
| File | Purpose |
|---|---|
package.json | private: true, "type": "module", packageManager pinned to pnpm@11.5.2 |
pnpm-workspace.yaml | packages: [doc], minimumReleaseAge: 0, allowBuilds.esbuild, and any required trustPolicyExclude setting |
circuit.config.ts | See Reference → circuit.config.ts |
README.md | Commands, the first circuit task, tool requirements |
CLAUDE.md, AGENTS.md | Thin pointers to circuit/, written per --agent |
.gitignore | Includes .circuit-cache/ |
ZUDO_DEPS_PINS.md | Provenance for the vendored zudo-doc scaffold — see Concepts → Ownership and upgrades |
circuit/
| Path | Purpose |
|---|---|
WORKFLOW.md | The canonical workflows A–G — see Workflows |
agent-task-examples.md | Nine short example requests, English + Japanese |
templates/ | The 10 unpublished authoring templates, plus the CAD asset receipt template (.json and .md) |
checks/ | What each check establishes, and what it doesn't |
publication/, publication/ | Empty at scaffold time — see Publication schemas |
generated/ | The generated preflight report |
cad-receipts/ | Created when the first CAD asset is acquired (not present at scaffold time) |
.claude/skills/
| Path | Purpose |
|---|---|
component- | Owner-audit skill entry |
component- | Explicitly empty at scaffold time |
component-, external-vendor-qualifiers.json | Routing configuration |
component- | The step-by-step checklist Workflow B follows |
circuit- | Cross-component integration skill entry |
circuit- | { "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)
| Path | Purpose |
|---|---|
pages/docs/[[...slug]].tsx, pages/ | The host route stub, with the islands seed import added |
pages/ | Side-effect import of @takazudo/ |
src/ | Spreads circuitDocMdxExtras into the host's MDX component set |
src/ | Imports the package's styles.css after zudo-doc's own CSS |
zfb.config.ts | claudeResources { claudeDir: "../.claude", scanRoot: ".." }, docHistoryExclude ["components", "components/**"], defaultLocaleOnlyPrefixes for / and /, themePacks: ["default"], dynamicPageTransition, llmsTxt, strictContentBridge |
src/ | Authored — yours to write |
src/ | Generated — never hand-edited |
public/ | 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
| Script | Runs |
|---|---|
pnpm dev | pnpm --dir doc dev |
pnpm build | zudo-circuit-doc models && zudo-circuit-doc generate && pnpm --dir doc build |
pnpm check | zudo-circuit-doc check && pnpm --dir doc check |
pnpm circuit:check | zudo-circuit-doc validate |
pnpm circuit:generate | zudo-circuit-doc generate |
pnpm circuit:doctor | zudo-circuit-doc doctor |
pnpm check:site | zudo-circuit-doc check-built && zudo-circuit-doc scan && pnpm --dir doc check:links -- --strict-anchors --strict-broken |
pnpm previews:generate | zudo-circuit-doc footprints generate (optional; needs Docker) |
Revision History
CreatedUpdated