Skip to content

Commit 6dbd0bd

Browse files
authored
docs: migration enhancement (#2605)
1 parent 7d1223e commit 6dbd0bd

File tree

2 files changed

+46
-4
lines changed

2 files changed

+46
-4
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,17 @@
66

77
[![logo](docs/logo.jpg)](https://codesandbox.io/s/bfplr)
88

9-
> [!WARNING] > **v11 Alpha:** This package is currently in **alpha** for v11. The API, files, and features are **subject to frequent change and breaking updates** as we work toward a stable release.
9+
> [!WARNING]
10+
> **v11 Alpha** β€” This package is currently in **alpha** for v11. APIs, files, and features are **subject to change**.
11+
>
12+
> πŸ“– **[Migration Guide](./devDocs/MIGRATION_V10_TO_V11.md)** β€” Start here for upgrade instructions
1013
>
11-
> Be sure to check the [v11 migration guide](./devDocs/MIGRATION_v10_TO_V11.md) for more information and best practices during this period.
14+
> - πŸ› [Report an issue](https://github.com/pmndrs/drei/issues/new) β€” Found a bug? Let us know
15+
> - πŸ’¬ [Join the discussion](https://github.com/pmndrs/drei/discussions) β€” Questions or ideas
16+
> - πŸ“‹ [Track progress](https://github.com/pmndrs/drei/milestone/2) β€” See what's coming
17+
>
18+
> ⚠️ **This alpha bundles @react-three/fiber v10** until R3F v10 is published to NPM.
19+
> Remove any existing `@react-three/fiber` from your dependencies before testing.
1220
1321
A growing collection of useful helpers and fully functional, ready-made abstractions for [@react-three/fiber](https://github.com/pmndrs/react-three-fiber).
1422

@@ -18,9 +26,11 @@ If you make a component that is generic enough to be useful to others, think abo
1826
npm install @react-three/drei
1927
```
2028

21-
> [!IMPORTANT] > **v11 is ESM-only.** We no longer ship CommonJS bundles. This follows the ecosystem-wide shift to ESM as the standard β€” matching `@react-three/fiber`, Three.js, and [Storybook 10](https://storybook.js.org/blog/storybook-is-going-esm-only/). All modern bundlers handle ESM natively.
29+
> [!IMPORTANT]
30+
> **v11 is ESM-only.** We no longer ship CommonJS bundles. This follows the ecosystem-wide shift to ESM as the standard β€” matching `@react-three/fiber`, Three.js, and [Storybook 10](https://storybook.js.org/blog/storybook-is-going-esm-only/). All modern bundlers handle ESM natively.
2231
23-
> [!NOTE] > ~~this package is using the stand-alone [`three-stdlib`](https://github.com/pmndrs/three-stdlib) instead of [`three/examples/jsm`](https://github.com/mrdoob/three.js/tree/master/examples/jsm).~~
32+
> [!NOTE]
33+
> ~~This package is using the stand-alone [`three-stdlib`](https://github.com/pmndrs/three-stdlib) instead of [`three/examples/jsm`](https://github.com/mrdoob/three.js/tree/master/examples/jsm).~~
2434
> Reliance on STD-Lib has been removed with v11. The threejs repo and @types folks are doing a much better job and supporting/working with core on these common assets serves us better.
2535
2636
New scripts, components, shaders, can be addded here in this repo or in the upcoming market.

β€ŽdevDocs/MIGRATION_V10_TO_V11.mdβ€Ž

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,37 @@
11
# Migration Guide: Drei v10 β†’ v11
22

3+
> **Alpha Release** β€” v11 is currently in alpha. We'd love your feedback!
4+
>
5+
> - πŸ› [Report an issue](https://github.com/pmndrs/drei/issues/new) β€” Found a bug? Let us know
6+
> - πŸ’¬ [Join the discussion](https://github.com/pmndrs/drei/discussions) β€” Questions or ideas
7+
> - πŸ“‹ [Track progress](https://github.com/pmndrs/drei/milestone/2) β€” See what's coming
8+
> - πŸ”§ [Remaining components](https://github.com/pmndrs/drei/issues/2603) β€” WebGPU migration tracker
9+
10+
---
11+
12+
> ⚠️ **Bundled R3F v10**
13+
>
14+
> This alpha release **bundles @react-three/fiber v10** directly until R3F v10 is published to NPM.
15+
> Once R3F v10 alpha is available on NPM, drei will switch to a normal peer dependency.
16+
>
17+
> **What this means for you:**
18+
>
19+
> - Don't install R3F separately β€” it's included
20+
> - Your project may have version conflicts if you have an existing R3F installation
21+
> - Remove any existing `@react-three/fiber` from your dependencies before testing
22+
23+
---
24+
25+
## Progress: ~90%
26+
27+
**What's left:**
28+
29+
- [ ] A few components still need WebGPU implementations
30+
- [ ] Full build and test shakedowns
31+
- [ ] Open issue and PR processing
32+
- [ ] Documentation polish and examples
33+
- [ ] Final peer dependency coordination with R3F v10
34+
335
---
436

537
## Overview

0 commit comments

Comments
Β (0)