diff --git a/docs/developer-guide.md b/docs/developer-guide.md index f568f53..983d2c1 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -464,7 +464,6 @@ crates/rust4d_render/src/ │ └── types.rs # GPU-compatible data structures ├── renderable.rs # RenderableGeometry: World to GPU buffers └── shaders/ - ├── slice.wgsl # Legacy 5-cell slicing (compute) ├── slice_tetra.wgsl # Tetrahedra slicing (compute) └── render.wgsl # 3D rendering (vertex + fragment) ``` diff --git a/scratchpad/plans/engine-roadmap-2026/phase-1-foundation.md b/scratchpad/plans/engine-roadmap-2026/phase-1-foundation.md index e377179..8f3d0b0 100644 --- a/scratchpad/plans/engine-roadmap-2026/phase-1-foundation.md +++ b/scratchpad/plans/engine-roadmap-2026/phase-1-foundation.md @@ -1,12 +1,21 @@ # Phase 1: Foundation - Scene Serialization & Configuration System **Created:** 2026-01-27 -**Status:** Ready +**Updated:** 2026-01-28 +**Status:** COMPLETE **Priority:** P0 (Critical Foundation) **Total Effort:** 4 sessions (2 sessions per track) --- +**COMPLETION NOTE (2026-01-28)**: This phase was completed with the following notes: +- Phase 1A (Scene Serialization): Complete - RON format working for scenes +- Phase 1B (Configuration System): Complete - TOML config with figment for hierarchical overrides +- `ColliderTemplate` was not implemented as planned; colliders are created from entity tags instead +- The physics body creation uses a simpler approach without explicit ColliderTemplate types + +--- + ## Overview Phase 1 establishes the foundational infrastructure for content creation and user customization. It consists of two parallel tracks that can be developed independently: diff --git a/scratchpad/plans/engine-roadmap-2026/phase-2-scene-management.md b/scratchpad/plans/engine-roadmap-2026/phase-2-scene-management.md index 1bb5c7d..489bf65 100644 --- a/scratchpad/plans/engine-roadmap-2026/phase-2-scene-management.md +++ b/scratchpad/plans/engine-roadmap-2026/phase-2-scene-management.md @@ -1,12 +1,23 @@ # Phase 2: Scene Management **Created:** 2026-01-27 -**Status:** Ready +**Updated:** 2026-01-28 +**Status:** COMPLETE **Sessions:** 3 (1 for 2A, 2 for 2B) **Priority:** P1 - High --- +**COMPLETION NOTE (2026-01-28)**: This phase was completed with the following differences from the original plan: +- Phase 2A (Scene Manager): Complete - Basic scene management implemented +- Phase 2B (Prefab System): Implemented as `EntityTemplate` instead of a separate `Prefab` struct + - EntityTemplate provides the same core functionality (reusable entity definitions) + - Override support was descoped for simplicity + - Children/nested prefabs were not implemented +- The simpler EntityTemplate approach was chosen to avoid over-engineering before real use cases emerged + +--- + ## Overview Phase 2 adds multi-scene support and a prefab system to Rust4D. This phase enables scene switching (menus, levels, overlays) and runtime entity spawning from templates. diff --git a/scratchpad/plans/engine-roadmap-2026/phase-3-documentation.md b/scratchpad/plans/engine-roadmap-2026/phase-3-documentation.md index 56b5ea8..44c6ec0 100644 --- a/scratchpad/plans/engine-roadmap-2026/phase-3-documentation.md +++ b/scratchpad/plans/engine-roadmap-2026/phase-3-documentation.md @@ -1,13 +1,28 @@ # Phase 3: Documentation **Created:** 2026-01-27 -**Status:** Ready +**Updated:** 2026-01-28 +**Status:** COMPLETE **Priority:** P2 **Estimated Effort:** 4-5 sessions **Dependencies:** None (can run in parallel with other phases) --- +**COMPLETION NOTE (2026-01-28)**: This phase was completed. Documentation files created: +- **Phase 3A (Quick Wins)**: Complete + - `examples/` directory with 4 working examples (01-04) + - `examples/README.md` with example index + - Enhanced `README.md` with project status, 4D explanation, features + - `ARCHITECTURE.md` with Mermaid diagrams showing system design +- **Phase 3B (Comprehensive Guides)**: Complete + - `docs/getting-started.md` - New user onboarding guide + - `docs/user-guide.md` - Comprehensive manual + - `docs/developer-guide.md` - Internals and contribution guide + - `docs/README.md` - Documentation index page + +--- + ## Overview Phase 3 establishes comprehensive user-facing and contributor-facing documentation for Rust4D. Currently, the codebase has strong internal documentation (doc comments) but lacks external resources for users and contributors to understand and use the engine effectively.