Lattice Documentation
Lattice is a local-first engineering memory and workflow layer. Start with the root README.md (简体中文).
Reading order
Section titled “Reading order”| Document | Contents | Audience |
|---|---|---|
| quick-start.md | Install, initialize, scan projects, first task and spec | First-time users |
| concepts.md | Specs, tasks, checkpoints, project relations, search and sync | Readers building a mental model |
| web-workbench.md | The four views, canvas filters, detail panels, search and the public demo | Web workbench users |
| architecture.md | Layered architecture (core → services → hosts → clients), multi-client evolution (M1–M6 / P1–P3), contract tests | Readers who want the internal design |
| directory-and-config.md | ~/.lattice layout, config files, scope conventions |
Data/config troubleshooting |
| spec-template-registry.md | Spec template repository layout (built-in / remote templates) | Template authors |
Package docs
Section titled “Package docs”Package READMEs use English as the default entry with Simplified Chinese translations.
- @qcqx/lattice-core — domain core
- @qcqx/lattice-protocol — cross-host contracts, types-only
- @qcqx/lattice-services — use-case layer shared by hosts
- @qcqx/lattice-cli — command line
- @qcqx/lattice-web — web server
- @qcqx/lattice-web-ui — shared React UI
- VS Code extension — sidebar views, graph, diagnostics
AI / Agent workflows
Section titled “AI / Agent workflows”Templates injected into AI clients (Cursor / Claude Code / Qoder / Trae and others):
Contributing
Section titled “Contributing”- CONTRIBUTING.md — development environment, commands, layer conventions, commit rules
- SECURITY.md — vulnerability reporting
- CODE_OF_CONDUCT.md — code of conduct