Skip to content

Commit ed1b628

Browse files
Docs: AGENTS.md conventions + reorganize documentation under Docs/
AGENTS.md (imported by CLAUDE.md) carries the project agent ground rules and the documentation layout: EPIC-LIST.md, Design/, Instructions/, Research/{date}-{subject}, Plans/{date}-{task}, Subagents/, DevTodo/, Blog/. Existing docs/ and prd/ trees migrated accordingly; source-comment references and the README docs section updated; Docs/EPIC-LIST.md authored with shipped/current/backlog epics.
1 parent 358d665 commit ed1b628

34 files changed

Lines changed: 1268 additions & 1164 deletions

AGENTS.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Agent Guide — BinaryConstruct Skybox
2+
3+
Free procedural stellar skybox editor (skyboxeditor.com). TypeScript + React
4+
+ three.js/WebGL2, fully client-side. MIT.
5+
6+
## Ground rules
7+
8+
- Determinism contract: no `Math.random` in generation/render — seeded
9+
`MsvcRng`/`PerlinNoise` streams only; new features derive new seed offsets
10+
so legacy sequences stay identical.
11+
- Gate everything: `npm test`, `npm run build`, `npm run lint` must pass.
12+
- Verify visuals yourself: build, serve `dist`, screenshot with Playwright,
13+
and read the screenshot before calling rendering work done
14+
(see Docs/Instructions/VERIFICATION.md).
15+
- Git identity is repo-local (`BinaryConstruct`); never add Co-Authored-By
16+
or AI-attribution lines to commits.
17+
- Scene JSON schema is generated from `src/core/io.ts` — after changing the
18+
field tables, regenerate with `npx vitest run src/core/schema.test.ts -u`.
19+
20+
## Documentation
21+
22+
Place all plans, subagent instructions and results, results, research in subfolders of
23+
./Docs
24+
- EPIC-LIST.md - constantly updated high-level goals, status, current focus, and links to plans/research/todos so project direction is never lost
25+
- Design/ - durable developer-facing game design documentation. This is the
26+
real design and architecture reference for humans, not AI in-progress work.
27+
Keep class purpose, rules, setup, requirements, content authoring rules, and system
28+
architecture here. Structure it like a HacknPlan-style design model: a tree of
29+
game design elements that explains what is being built and links to execution
30+
docs when useful.
31+
- Instructions/{name}.md - instructions, CLI and API tooling how to
32+
- Research/{date-time}-{subject}.md - ALL research summaries, hard facts
33+
- Plans/{date-time}-{task}.md - ALL tasks plans and PRD documents
34+
- Subagents/{date-time}-{task}-{instructions,results}.md - REQUIRED ALL subagent launch prompts, ALL subagent results write here, even if they are returned inline
35+
- DevTodo/{task}.md - implementation follow-up tasks that should remain manual/editor-facing or be picked up in later focused changes
36+
- Blog/{date-time}-{task}.md - used for post-task analysis, what went well, what didn't work, what should be done better
37+
etc.
38+
39+
Update `Docs/EPIC-LIST.md` whenever a high-level goal is added, completed,
40+
blocked, materially descoped, or superseded.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Docs/DevTodo/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# DevTodo
2+
3+
One file per manual/editor-facing follow-up task.

Docs/EPIC-LIST.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Epic List
2+
3+
High-level goals, status, and current focus. Update whenever a goal is
4+
added, completed, blocked, materially descoped, or superseded.
5+
6+
**Current focus:** Layer/PCG consolidation
7+
([plan](Plans/2026-07-16-prd-layer-pcg-consolidation.md)) — awaiting go.
8+
9+
## Shipped
10+
11+
- **E1 — Spacescape rewrite core** ✅ Layer stack (nebula, volumetric,
12+
stars, flares), legacy `.xml` import with byte-exact determinism, `.sspj`
13+
native format, cubemap/equirect/HDR/EXR export.
14+
[Design/ARCHITECTURE-MODERNIZATION.md](Design/ARCHITECTURE-MODERNIZATION.md),
15+
[Blog/2026-07-16-execution-modern-look.md](Blog/2026-07-16-execution-modern-look.md)
16+
- **E2 — PCG workbench** ✅ Parameterized star/galaxy/nebula/planet/anomaly
17+
generators, bake modes (color/lightness/dark), bake-to-sprites.
18+
[Plans/2026-07-16-prd-pcg-workbench.md](Plans/2026-07-16-prd-pcg-workbench.md),
19+
[Plans/2026-07-16-pcg-stellar-styles.md](Plans/2026-07-16-pcg-stellar-styles.md)
20+
- **E3 — Positional celestial layers** ✅ Sun/planet/sprite quads with
21+
spherical placement, drag-to-place, lock; black-hole lens layer.
22+
[Plans/2026-07-16-prd-positional-celestial-layers.md](Plans/2026-07-16-prd-positional-celestial-layers.md)
23+
- **E4 — Exports** ✅ Per-layer + data export, flattened composite,
24+
deterministic batch variations.
25+
[Plans/2026-07-16-prd-per-layer-data-export.md](Plans/2026-07-16-prd-per-layer-data-export.md),
26+
[Plans/2026-07-16-prd-batch-seed-export.md](Plans/2026-07-16-prd-batch-seed-export.md)
27+
- **E5 — Geodesic black holes** ✅ Planar Schwarzschild integrator; PCG
28+
sprite traced per pixel; lens layer with deflection LUT + analytic disc
29+
(Luminet double-loop anatomy, Doppler min/max color).
30+
[Research/2026-07-16-blackhole-geodesics.md](Research/2026-07-16-blackhole-geodesics.md)
31+
- **E6 — AI-authorable scenes** ✅ Script tab (live two-way JSON,
32+
line-precise errors), published JSON schema, scene-authoring skill.
33+
- **E7 — Ship it** ✅ BinaryConstruct branding, MIT license, AI policy,
34+
GitHub (`BinaryConstruct/skyboxeditor`) with `verify` CI gate + ruleset,
35+
Cloudflare Workers deploy — live at skyboxeditor.binaryconstruct.workers.dev.
36+
Remaining: attach the skyboxeditor.com custom domain (dashboard).
37+
38+
## In progress / next
39+
40+
- **E8 — Layer/PCG consolidation** 🔜 Positional layers gain full generator
41+
parity (16 sun styles, 6 galaxy morphologies, planet styles, new anomaly
42+
layer type), spec-driven from one param table.
43+
[Plans/2026-07-16-prd-layer-pcg-consolidation.md](Plans/2026-07-16-prd-layer-pcg-consolidation.md)
44+
45+
## Backlog / ideas
46+
47+
- PCG component-layer refactor follow-ups:
48+
[Plans/2026-07-16-prd-pcg-component-refactor.md](Plans/2026-07-16-prd-pcg-component-refactor.md)
49+
- Stellar content expansion:
50+
[Plans/2026-07-16-prd-stellar-content.md](Plans/2026-07-16-prd-stellar-content.md)
51+
- Bundle-size code-splitting (vite warns at ~1 MB main chunk).

Docs/Instructions/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Instructions
2+
3+
How-to docs for CLI/API tooling and workflows.
File renamed without changes.

0 commit comments

Comments
 (0)