From 82fcfd2656a9f7085c54407d9c390a7d413c4b5a Mon Sep 17 00:00:00 2001 From: skal Date: Mon, 9 Feb 2026 17:48:18 +0100 Subject: docs: Streamline top-level project files Move implementation details to design docs, keep TODO.md and PROJECT_CONTEXT.md concise and high-level. Improves readability. Changes: - TODO.md: Condensed from 162 to 52 lines - PROJECT_CONTEXT.md: Grouped design docs by category - Recently Completed: Date-grouped format Co-Authored-By: Claude Sonnet 4.5 --- PROJECT_CONTEXT.md | 73 +++++++++++++++++++++++++++++------------------------- 1 file changed, 39 insertions(+), 34 deletions(-) (limited to 'PROJECT_CONTEXT.md') diff --git a/PROJECT_CONTEXT.md b/PROJECT_CONTEXT.md index 49b67c4..165fe60 100644 --- a/PROJECT_CONTEXT.md +++ b/PROJECT_CONTEXT.md @@ -43,54 +43,59 @@ ## Next Up -- **Task #5: Spectral Brush Editor** [IN PROGRESS] - - Web-based tool for procedurally tracing audio spectrograms - - Replace large .spec assets with tiny C++ code (50-100× compression) - - See TODO.md and `doc/SPECTRAL_BRUSH_EDITOR.md` +**Active:** +- Task #5: Spectral Brush Editor [IN PROGRESS] - Procedural spectrogram tool (50-100× compression) -- **Visuals & Content** - - Task #52: Procedural SDF Font - - Task #53: Particles Shader Polish - - Task #55: SDF Random Planes Intersection +**Visuals:** +- Task #52: Procedural SDF Font +- Task #53: Particles Shader Polish +- Task #55: SDF Random Planes Intersection -- **Project Structure** - - Task #77: Workspace System (Medium priority) +**Structure:** +- Task #77: Workspace System - Self-contained demo workspaces -- **Tooling & Optimization** - - Task #54: Tracy Integration - - Task #76: External Library Size Measurement (Low priority) +**Tooling:** +- Task #54: Tracy Integration +- Task #76: External Library Size Measurement + +**Details:** See `TODO.md` and individual design docs --- -## Design Docs Quick Reference +## Design Docs Reference -For detailed documentation, use Read tool to load specific docs: +**Core Systems:** +- `doc/ASSET_SYSTEM.md` - Build-time asset packer, 16-byte alignment +- `doc/SEQUENCE.md` - .seq timeline format with BPM notation +- `doc/TRACKER.md` - Audio pattern system, unit-less timing +- `doc/3D.md` - Hybrid SDF raymarching with BVH acceleration -- **doc/TRACKER.md**: Audio pattern system with unit-less timing -- **doc/3D.md**: Hybrid SDF raymarching with BVH acceleration -- **doc/ASSET_SYSTEM.md**: Build-time asset packer with 16-byte alignment -- **doc/BUILD.md**: Multi-platform builds (Debug/STRIP_ALL/FINAL_STRIP) -- **doc/SPECTRAL_BRUSH_EDITOR.md**: Web tool for tracing spectrograms -- **doc/SEQUENCE.md**: .seq timeline format with BPM notation -- **doc/MASKING_SYSTEM.md**: Auxiliary texture registry -- **doc/SCENE_FORMAT.md**: Binary scene format (SCN1) -- **doc/SIZE_MEASUREMENT.md**: External library size measurement strategy -- **doc/WORKSPACE_SYSTEM.md**: Multi-demo workspace organization -- **doc/test_demo_README.md**: 16s audio/visual sync test tool -- **doc/HOT_RELOAD.md**: Debug-only file change detection -- **doc/CONTEXT_MAINTENANCE.md**: Context hygiene protocol +**Formats:** +- `doc/SCENE_FORMAT.md` - Binary scene format (SCN1) +- `doc/MASKING_SYSTEM.md` - Auxiliary texture registry ---- +**Tools & Workflow:** +- `doc/BUILD.md` - Multi-platform builds (Debug/STRIP_ALL/FINAL_STRIP) +- `doc/SPECTRAL_BRUSH_EDITOR.md` - Procedural spectrogram tool +- `doc/WORKSPACE_SYSTEM.md` - Multi-demo organization +- `doc/HOT_RELOAD.md` - Debug-only file change detection +- `doc/SIZE_MEASUREMENT.md` - External library size measurement +- `doc/test_demo_README.md` - 16s audio/visual sync test -## Recently Completed (February 2026) +**Meta:** +- `doc/CONTEXT_MAINTENANCE.md` - Context hygiene protocol -- **Hot-Reload File Watcher** (Feb 9) - Debug-only file change detection with `--hot-reload` flag. Watches config files (assets, sequences, music) and notifies on changes. 0 bytes overhead in release builds. +--- -- **WGSL Uniform Buffer Validation (Task #75)** (Feb 9) - Standardized uniform buffer layout. Validation tool integrated into build. All effects use `CommonPostProcessUniforms` (binding 2) + effect-specific params (binding 3). Added `UNIFORM_BUFFER_GUIDELINES.md`. +## Recently Completed -- **Uniform Buffer Alignment (Task #74)** (Feb 9) - Fixed WGSL `vec3` alignment issues. Demo runs with 0 validation errors. +**Feb 9, 2026:** +- Hot-reload file watcher (debug-only, 0 bytes overhead) +- WGSL uniform buffer validation (Task #75) +- Uniform buffer alignment fixes (Task #74) -- **Shader Parametrization (Task #73)** (Feb 8) - Full uniform parameter system with .seq syntax. FlashEffect, ChromaAberrationEffect, GaussianBlurEffect support dynamic parameters. Size: ~400-500 bytes. +**Feb 8, 2026:** +- Shader parametrization system (Task #73) --- -- cgit v1.2.3