doxa-life/doxa-maps
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

point the tutorial at the studio folder and separate build from publish

Browse source
This commit is contained in:
doxa-maps-88655c70 2026-09-21 07:38:50 +00:00
parent 51b6fa3f6d
commit 70d0e36ad3
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/tutorial.md
View file

@ -29,7 +29,8 @@ want in plain English.
Most days you live in steps 3 and 4.
1. **Clone the repo** to your computer. *(Once, ever.)*
2. **Go into the maps folder:** `cd doxa-maps`.
2. **Go into the maps folder:** `cd doxa-maps-plugin-studio`. (The folder is the *studio* — a
sibling `doxa-maps/` may also exist; it is a different, older tree and has no `plugin-designs/`.)
3. **Run `bun run dev`.** Your staging page opens, showing **all** your maps.
4. **Make changes** — or tell an AI agent to — and watch them appear **instantly**.
5. **When you're happy, run `bun run build`.** This packages your maps for the website.
@ -45,7 +46,7 @@ Most days you live in steps 3 and 4.
Open a terminal and step into the maps folder:
```bash
cd doxa-maps
cd doxa-maps-plugin-studio
```
> **One-time setup:** this project uses **Bun**. Install it from <https://bun.sh>, then run
@ -166,7 +167,7 @@ is in **[how-to.md](./how-to.md)**.
| You type | What happens |
|---|---|
| `bun run dev` | Opens your live workshop showing **every** map. Changes appear instantly (HMR). No build. This is where you spend your time. |
| `bun run build` | Packages your maps into `public/`. The **only** step that publishes. Run it when you're ready to ship. |
| `bun run build` | Packages your maps into `public/` — the served web-root. The **only** build step you need. (Putting them on the live platform is a separate publish; see [develop-a-plugin-and-see-it-live.md](./develop-a-plugin-and-see-it-live.md).) |
`dev` is for **creating**; `build` is for **shipping**.