GPUI Deck

Contributing

Where each part of the source lives and how to verify a change.

LocationResponsibility
crates/cli/Source-copy CLI and recipe dependency catalogue
crates/base/src/The gpui-deck library and its behavior-level tests
crates/base/tests/Integration tests using the public API
crates/base/examples/starter.rsSmall complete application using only public APIs
crates/base/examples/two_styles.rsNative example and application-owned styles
crates/base/examples/presentation.rsCopyable light/dark application tokens used by the presentation recipes
crates/base/examples/recipes/Twenty-three catalogue recipes and Chart's supporting presentation; copyable application-owned source
crates/base/examples/assets/Embedded example artwork used by the preset preview and its image-decoding regression
docs/This documentation site: Fumapress (Fumadocs on Vite); pages live in docs/content/docs
crates/web-preview/Live documentation previews compiled to WebAssembly with GPUI's web backend
Cargo.toml / Cargo.lockWorkspace and matching dependency set

Initialize the library with gpui_deck::init(cx) and host application content in gpui_deck::Root. Use the starter as the small startup reference and the other native examples for larger compositions. Consumer applications can work directly with this source and supply their own presentation while reusing the behavior layer.

Verify a change

Run the formatting, Clippy, test and build commands listed under Verify changes in the README; the Verify workflow runs the same matrix on Linux, Windows and macOS.

Documentation site

This site is a Fumapress app (Fumadocs on Vite) in docs/, deployed to Cloudflare Workers. Pages are MDX files in docs/content/docs; Korean, Japanese and Chinese translations sit beside each page as name.ko.mdx, name.ja.mdx and name.zh.mdx. Live previews come from crates/web-preview, built to WebAssembly:

cd docs
npm ci
npm run preview:build   # cargo build for wasm32 + wasm-bindgen into public/preview
npm run dev
npm run lint && npm run typecheck
npm run build && npm run test:browser