WebGPU Particle Fluid Simulation — Documentation Index
This directory keeps only the documentation that adds value beyond the README and the OpenSpec source of truth.
Source of truth
The canonical project specs live in openspec/specs/:
| Document | Purpose |
|---|---|
| Product Requirements | Functional and non-functional requirements |
| Core Architecture RFC | Technical architecture decisions |
| Implementation Tasks RFC | Historical implementation task record |
| API Specification | Interface contracts and exposed types |
| Testing Specification | BDD and verification expectations |
Durable docs
| Document | Why it exists |
|---|---|
| API Reference | Code-facing reference for modules, types, and runtime contracts |
| Architecture Overview | Shorter architecture map for readers who do not want the full RFC first |
| Setup Guide | Local environment, LSP, editor, and hook setup |
| Performance Guide | Practical profiling and tuning notes for the runtime |
| Troubleshooting | Runtime and browser problem-solving guide |
| Workflow Guide | OpenSpec-first workflow, validation, review, and release hygiene |
Reader paths
- Trying the project: start with README and the hosted demo.
- Understanding the implementation: read Architecture Overview, then the Core Architecture RFC.
- Making changes: read Setup Guide, Workflow Guide, and Contributing.
- Checking expected behavior: read the matching document in
openspec/specs/before touching code.
What was removed
This doc set intentionally avoids placeholder tutorial trees, empty asset guides, and duplicated process text. If a new document does not have a clear purpose that is not already covered by README, OpenSpec, or an existing reference doc, it should not be added.