Skip to content

Commit 4cc246c

Browse files
committed
docs: add README to playground
1 parent 786c83e commit 4cc246c

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

playground/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# solid-three Tutorials Playground
2+
3+
A local Vite app for exploring `solid-three` API demos and examples interactively.
4+
5+
## Running
6+
7+
```bash
8+
pnpm install
9+
pnpm dev
10+
```
11+
12+
## Structure
13+
14+
```
15+
src/
16+
api/ # Per-feature API demos, one folder per concept
17+
examples/ # Larger composed examples (solar system, environment, …)
18+
controls/ # Shared orbit-controls and other helpers
19+
```
20+
21+
The sidebar groups **API** demos by category and lists **Examples** separately. Each API category maps to a folder under `src/api/`; each folder typically contains a `usage.tsx` entry point plus additional focused demo files.
22+
23+
## Adding a Demo
24+
25+
**API demo** — create a `.tsx` file under `src/api/<category>/`. It is picked up automatically via Vite glob import and appears in the sidebar.
26+
27+
**Example** — create a `.tsx` file under `src/examples/`. Same auto-discovery applies.
28+
29+
Each file should export a default component that renders the demo (with its own `<Canvas>` if needed).

0 commit comments

Comments
 (0)