Skip to content

CHANGES.md

Latest commit

 

History

History
126 lines (95 loc) · 3.75 KB

CHANGES.md

File metadata and controls

126 lines (95 loc) · 3.75 KB

Anatsui - Changes Summary

🔄 What Changed

❌ Removed: Canvas2D Fallback

All Canvas2D rendering code has been removed. The app now requires WebAssembly to run (which all modern browsers in 2026 support).

Files Changed:

  • ✅ Removed FallbackWarning.tsx component
  • ✅ Removed FALLBACK_LOGIC.md documentation
  • ✅ Removed all Canvas2D rendering code from Canvas.tsx (300+ lines)
  • ✅ Removed roundRect() helper function
  • ✅ Updated editorStore.ts to throw errors instead of falling back

✅ Added: WASM Error Screen

A comprehensive error screen now appears if WebAssembly fails to load.

New File: apps/web/src/components/WasmErrorScreen.tsx

Features:

  • Beautiful error UI with detailed diagnostics
  • Shows the actual error message
  • Lists possible causes:
    • WebAssembly disabled in browser
    • Module compilation failure
    • Network error
    • Development build incomplete
  • Actions:
    • Reload page button
    • Link to WebAssembly documentation
  • Browser diagnostics:
    • User agent string
    • WebAssembly availability check

📚 Added: Comprehensive Rust Documentation

New File: packages/core/ARCHITECTURE.md (200+ lines)

A complete study guide covering:

  • High-level architecture diagrams
  • Module-by-module breakdown with explanations
  • How data flows through the system
  • Key concepts explained (fractional indexing, CRDTs, tessellation)
  • Learning path (beginner → advanced)
  • Common development tasks with code examples
  • Debugging tips
  • Further reading resources

Enhanced Files:

  • packages/core/src/lib.rs - Added 100+ lines of detailed comments
  • packages/core/src/document/tree.rs - Added 200+ lines of documentation

What's Documented:

  • Why Rust and WebAssembly?
  • Module organization and responsibilities
  • Document tree structure (scene graph)
  • Parent-child relationships
  • Fractional indexing for z-order
  • Bezier curves and vector graphics
  • WebGL2 rendering pipeline
  • Transformation matrices
  • Tool state machines
  • CRDT-based multiplayer
  • Complete data flow example

🎯 Key Improvements

1. Simpler Codebase

  • Removed: 500+ lines of Canvas2D fallback code
  • Result: Cleaner, easier to maintain

2. Better Error Handling

  • Before: Silent fallback with warning banner
  • After: Clear error screen explaining the issue

3. Learning Resources

  • Before: Minimal comments, hard to understand
  • After: Comprehensive documentation with examples

🏃 Running the App

# Build WASM and start dev server
bun start

# Or run separately:
bun build:wasm  # Compile Rust to WASM
bun dev         # Start Vite dev server

The app will be at: http://localhost:3000

📖 Studying the Rust Code

Start with these files in order:

  1. packages/core/ARCHITECTURE.md - Read this first!
  2. packages/core/src/lib.rs - Entry point
  3. packages/core/src/document/tree.rs - Scene graph
  4. Follow the learning path in ARCHITECTURE.md

⚠️ Note About WebGL2 Integration

The Canvas component currently has placeholder code for WebGL2:

// TODO: Initialize WebGL2 context and pass to Rust renderer
// const gl = canvas.getContext('webgl2');
// wasmRenderer.init(gl);
// wasmRenderer.render(document, zoom, panX, panY);

The Rust rendering engine is built and ready, but not yet connected to the canvas. This is the next step to implement.

🐛 Warnings (Non-Critical)

The Rust compiler shows some warnings about unused imports and variables. These are safe to ignore for now and can be cleaned up later:

  • Unused imports in various modules
  • Unused variables in network.rs
  • Dead code in sync.rs and context.rs

All warnings, zero errors! ✅

Bottom Line: The codebase is now cleaner, better documented, and ready for you to study and extend!