You're viewing the v10 deployment.
View on master →

readme

This folder contains guides for developing and contributing to @react-three/fiber.

Quick Start

 
# Clone the repository
git clone https://github.com/pmndrs/react-three-fiber.git
cd react-three-fiber

# Install dependencies
pnpm install

# Start development mode
pnpm dev

# Launch examples
pnpm examples

Where to Go Next
  • Contributing — Standards, conventions, and what we expect from pull requests.
  • Development Guide — Workflow, project structure, and technical documentation index.
  • Build — Entry points, the shared core, renderer supports, and how the bundles are produced.
  • Testing — Test layout, the WebGPU mocks, and what runs in CI.

Where design rationale lives

There is no separate pile of design docs. The why sits with the thing it explains:

  • Frame loop — why one global scheduler, why named dependencies instead of priority numbers, why throttled jobs never catch up: frame-loop docs.
  • WebGPU / TSL — why outputNode is explicit, how useRenderPipeline handles HMR: render-pipeline and hmr.
  • Entry points, the shared core and renderer supports — BUILD.md.

This is deliberate. A planning doc that outlives its decision becomes misinformation, and a rationale doc kept off to the side gets read after the thing it describes has already changed. If a decision is worth recording, record it where someone will hit it — in the docs for the feature, or in a comment on the code that implements it.

Superseded planning material is archived in Notion, not in this repo.

Edit this page