Flexweave is a Rust workspace for reusable mechanics primitives.
| Surface | Path | Purpose |
|---|---|---|
| Flexweave Rust crate | core |
Rust crate for deterministic mechanics primitives. |
| Documentation site | docs |
Hostable Fumadocs site for Flexweave documentation. |
| Project docs | project-docs |
Source-first ADRs and implementation models. |
| Command | Purpose |
|---|---|
bun run build |
Build the Rust crate and docs site. |
bun run check |
Run read-only formatting, Rust checks, and docs typecheck. |
bun run docs:dev |
Start the local documentation site. |
bun run fix |
Format supported files. |
bun run test |
Run Rust crate tests. |
bun run verify |
Run the full workspace verification gate. |
The hosted documentation is organized as a book-style guide with a separate top-level API Reference:
Start with: