Getting Started

Create a circuit documentation project, check your setup, and begin your first task.

zudo-circuit-doc helps you build a circuit project whose decisions, component evidence, and open questions stay visible in its documentation. It has two parts: create-zudo-circuit-doc creates a project, and @takazudo/zudo-circuit-doc supplies its commands, evidence checks, and component pages. The generated documentation site runs on zudo-doc.

It is for people developing circuits with an agent, or maintaining the resulting evidence themselves. A new project gives you a project brief, an agent workflow, an initially empty component catalog, and commands to validate evidence and regenerate the site. You can start documenting an idea before choosing a component or creating any CAD files.

Start in three steps

1. Create a project: run pnpm create zudo-circuit-doc my-circuit when the packages are available on npm. Until then, that page has a working tarball route.

2. In the new directory, run pnpm circuit:doctor, then pnpm dev to open its site. The first run explains the output.

3. Begin your first task: write the project brief, then add a component when you know its exact part number.

Check Requirements before creating a project. What you get shows the generated files, and Current limitations describes features that are not included.

What this site covers

This site documents the initializer and runtime software. Getting Started takes you from installation to the first task. Concepts explains the evidence, publication, CAD, and file ownership rules. Workflows describes the tasks an agent can carry out in a generated project. Reference lists commands, configuration, schemas, and generated files. Claude Skills exposes the workflow resources used by agents. Changelog records package changes.

Your generated project's doc/ directory is a separate site for your circuit. Its authored project pages and generated component pages are the output of the work described here.