Merge pull request #89 from AnuKritiW/docs/cleanup

Cleanup + Documentation Improvements

Author: AnuKritiW

.github/workflows/check-tests.yml

@@ -37,8 +37,9 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
-        project: [backend, frontend]
+        shard: ['1/2','2/2']
 
     steps:
       - name: Checkout repo
@@ -53,10 +54,5 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Run ${{ matrix.project }} tests
-        run: |
-          if [ "${{ matrix.project }}" = "backend" ]; then
-            npx vitest run tests/backend
-          else
-            npx vitest run tests/frontend
-          fi
+      - name: Run unit tests (shard ${{ matrix.shard }})
+        run: npx vitest run tests --shard ${{ matrix.shard }}

README.md

@@ -113,20 +113,37 @@ npm run deploy
 
 ```
 src/
-├── components/             # Vue components
-│   ├── EditorPanel.vue     # Monaco shader editor
-│   ├── PreviewPanel.vue    # WebGPU render canvas
-│   ├── ResourcesPanel.vue  # Mesh/texture selector
-│   └── ...
-├── webgpu/                 # WebGPU engine
-│   ├── renderer.ts         # Main renderer
-│   ├── pipeline.ts         # Render pipeline
-│   ├── shaders.ts          # Shader compilation
-│   └── ...
-├── composables/            # Vue composables
-├── shaders/                # Example WGSL shaders
-├── utils/                  # Utility functions
-└── styles/                 # Global styles
+├── ui/                               # UI layer (Vue.js frontend)
+│   ├── components/                   # Vue components
+│   │   ├── panels/                   # Main application panels
+│   │   │   ├── EditorPanel.vue       # Monaco shader editor
+│   │   │   ├── PreviewPanel.vue      # WebGPU render canvas
+│   │   │   ├── ResourcesPanel.vue    # Mesh/texture selector
+│   │   │   └── ConsolePanel.vue      # Error/output display
+│   │   ├── modals/                   # Modal dialogs
+│   │   │   ├── TextureModal.vue      # Texture selection
+│   │   │   └── MeshModal.vue         # Mesh selection
+│   │   └── WebGPUWarning.vue         # Browser compatibility
+│   ├── composables/                  # Vue composition functions
+│   │   ├── useShaderRunner.ts        # Shader execution
+│   │   ├── useTextures.ts            # Texture management
+│   │   └── useMesh.ts                # Mesh handling
+│   └── styles/                       # UI styling
+│       └── app.css
+├── core/                             # Core WebGPU setup
+│   └── context.ts                    # Device/adapter management
+├── runtime/                          # Rendering execution
+│   └── renderer.ts                   # Main rendering engine
+├── pipeline/                         # Rendering pipeline
+│   ├── pipeline.ts                   # Render pipeline factory
+│   └── uniforms.ts                   # Uniform buffer management
+├── shader/                           # Shader processing
+│   ├── shaderUtils.ts                # Shader compilation & templates
+│   └── wgslReflect.ts                # WGSL parsing & reflection
+└── resources/                        # Asset management
+    ├── textures.ts                   # Texture loading & binding
+    └── mesh/
+        └── objParser.ts              # OBJ file parsing
 ```
 
 ## Links