An mdBook under docs/book: a user guide (getting started, UI tour, sketching, features, parameters, components and joints, sheet metal, plastic, files, shortcuts, MCP) and a developer guide (CONTRIBUTING, architecture, command engine, kernel boundary, persistent naming, test harnesses, and the existing docs/*.md pages). `cargo xtask book` generates the command reference from `solvecraft-cli commands` and renders the screenshots with `solvecraft-cli snapshot`, then runs mdbook. .github/workflows/pages.yml publishes the book at /solvecraft/ and the web app at /solvecraft/app/ (skipped while the repository is private). .github/workflows/ci.yml runs `cargo xtask ci` on pull requests. README and Help → Documentation link to the book. Fixes #28 Fixes #8 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1014 B
1014 B
Summary
User guide
- Getting started
- A tour of the window
- Sketching and constraints
- Solid features
- Parameters and expressions
- Components and joints
- Sheet metal
- Plastic parts
- Import and export
- Keyboard shortcuts
- Driving SolveCraft with an AI agent (MCP)
Developer guide
- Contributing
- Architecture
- The command engine
- The kernel boundary and truck
- Persistent naming
- Test harnesses
- Control protocol
- Fusion oracle
- Command parity
- STEP import