bherbruckandClaude Opus 5.5
0d7e456bc1
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>
35 lines
1014 B
Markdown
35 lines
1014 B
Markdown
# Summary
|
|
|
|
[Introduction](introduction.md)
|
|
|
|
# User guide
|
|
|
|
- [Getting started](guide/getting-started.md)
|
|
- [A tour of the window](guide/ui-tour.md)
|
|
- [Sketching and constraints](guide/sketching.md)
|
|
- [Solid features](guide/features.md)
|
|
- [Parameters and expressions](guide/parameters.md)
|
|
- [Components and joints](guide/assemblies.md)
|
|
- [Sheet metal](guide/sheet-metal.md)
|
|
- [Plastic parts](guide/plastic.md)
|
|
- [Import and export](guide/files.md)
|
|
- [Keyboard shortcuts](guide/shortcuts.md)
|
|
- [Driving SolveCraft with an AI agent (MCP)](guide/mcp.md)
|
|
|
|
# Developer guide
|
|
|
|
- [Contributing](dev/contributing.md)
|
|
- [Architecture](dev/architecture.md)
|
|
- [The command engine](dev/commands.md)
|
|
- [The kernel boundary and truck](dev/kernel.md)
|
|
- [Persistent naming](dev/naming.md)
|
|
- [Test harnesses](dev/testing.md)
|
|
- [Control protocol](dev/control-protocol.md)
|
|
- [Fusion oracle](dev/oracle.md)
|
|
- [Command parity](dev/parity.md)
|
|
- [STEP import](dev/step-import.md)
|
|
|
|
# Reference
|
|
|
|
- [Command reference](reference/commands.md)
|