ZenFG documentation is organized by responsibility. Package READMEs are the installed quick references for their own public APIs; this directory owns the shared model, compatibility, and maintainer-facing guides.
| Goal | Start here |
|---|---|
| Understand what ZenFG owns and how a frame is modeled | Core concepts |
| Build with TypeScript and WebGPU | @zenfg/webgpu README |
| Build with Rust and wgpu | zenfg README |
| Produce, validate, or migrate Snapshot data | @zenfg/snapshot README or zenfg-snapshot README |
| Embed or open the Inspector | @zenfg/inspector README or the hosted Inspector |
| Explore live WebGPU showcases and package recipes, their source, and captures | Hosted Playground |
| Check supported versions and toolchains | Compatibility |
| Contribute or publish a release | Contributing and release process |
| Information | Canonical source |
|---|---|
| Package installation, common tasks, and first-use pitfalls | The package or crate README shipped with that artifact |
| Complete supported workflows | The TypeScript and Cargo examples shipped with the runtime packages |
| Exact signatures, fields, defaults, and errors | Public TSDoc in packaged declarations/source and rustdoc on docs.rs |
| Ownership, content, dependency, lifetime, and integration semantics | Core concepts |
| Snapshot wire structure and cross-field rules | @zenfg/snapshot specification |
| Supported package, wire, and toolchain versions | Compatibility |
| Release verification and history | Release validation and the changelog |
Additional maintainer documents cover the release process, the current release checklist, and Snapshot or runtime conformance procedures referenced by those guides.
The repository root README is maintained in English and Simplified Chinese. Technical documents, package READMEs, API documentation, and examples are maintained in English so semantic changes have one normative explanation.
Application-like showcases, cross-package workflows, and third-party
integrations live in private workspaces under examples/. Focused public API
recipes live with and ship in their owning package. The hosted Playground owns
presentation, exact-source display, and Inspector integration through
application-local catalog adapters; example implementations do not import the
Playground. See examples/README.md for the ownership
boundary.