docs: refresh README for the WebGPU sensor stack + version bumps - #88
Conversation
The README was written before the .NET 10 / Vite 8 / TS 6 upgrade and predates the entire WebGPU sensor arc (PRs #66–#87). Bring it back into sync with reality. - Tech Stack: .NET 9 → 10, Three.js r175 → 0.184, TS 5 + Vite 6 → TS 6 + Vite 8; new rows for the WebGPU sensor primitive and Vitest frontend tests. - Features: add the brick-map raymarcher (mesh-link LoS + per-drone LiDAR off one kernel) and the SignalR lazy chunk. - Project Layout: include `webgpu/` (device, sensors, registry, world, brickmap, los, lidar, rays, shaders/) and `__tests__/`, plus the new `sensorStatsOverlay.ts`. - Keyboard shortcuts: add `i` for the sensor stats overlay. - License footer: 2024 ResQ Technologies Ltd. → 2026 ResQ Systems, Inc. — matches the SPDX headers across the codebase. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThe README's "Features" section documents a new WebGPU sensor-stack with voxelization, drone line-of-sight detection, and LiDAR scanning. Additionally, SignalR lazy-loading, sensor stats overlay (toggled via Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 9 minutes and 50 seconds.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 389: The README row currently includes a machine-specific runtime "~380
ms" in the table cell "Frontend tests | Vitest 4 | Host-side WebGPU primitive
smoke tests (~17 cases, ~380 ms)"; remove the "~380 ms" (or replace it with a
non-runtime descriptor such as "approx. ~17 cases" or "quick smoke tests") so
the row is capability-focused and not tied to environment-specific timing
information, updating the text in that table cell accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a WebGPU-based sensor primitive utilizing a brick-map raymarcher for drone line-of-sight and LiDAR scans. Key updates include lazy-loading for SignalR, a developer stats overlay, and a significant upgrade of the technology stack to .NET 10, TypeScript 6, and Vite 8. Feedback suggests refining the README to accurately reflect that voxelization is re-triggered upon terrain changes rather than occurring only once.
- "voxelizes once" was misleading — the brick-map rebuilds when the terrain preset switches or a heightmap override is installed (the `onTerrainChange` path landed in #74). Reword to "voxelizes at boot (and rebuilds on terrain edits)" so the docs match the code. - Drop "(~17 cases, ~380 ms)" from the Vitest row in Tech Stack — machine-specific runtime that drifts with each new test, not a capability claim. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: refresh README for the WebGPU sensor stack + version bumps The README was written before the .NET 10 / Vite 8 / TS 6 upgrade and predates the entire WebGPU sensor arc (PRs #66–#87). Bring it back into sync with reality. - Tech Stack: .NET 9 → 10, Three.js r175 → 0.184, TS 5 + Vite 6 → TS 6 + Vite 8; new rows for the WebGPU sensor primitive and Vitest frontend tests. - Features: add the brick-map raymarcher (mesh-link LoS + per-drone LiDAR off one kernel) and the SignalR lazy chunk. - Project Layout: include `webgpu/` (device, sensors, registry, world, brickmap, los, lidar, rays, shaders/) and `__tests__/`, plus the new `sensorStatsOverlay.ts`. - Keyboard shortcuts: add `i` for the sensor stats overlay. - License footer: 2024 ResQ Technologies Ltd. → 2026 ResQ Systems, Inc. — matches the SPDX headers across the codebase. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: address review feedback on PR #88 - "voxelizes once" was misleading — the brick-map rebuilds when the terrain preset switches or a heightmap override is installed (the `onTerrainChange` path landed in #74). Reword to "voxelizes at boot (and rebuilds on terrain edits)" so the docs match the code. - Drop "(~17 cases, ~380 ms)" from the Vitest row in Tech Stack — machine-specific runtime that drifts with each new test, not a capability claim. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: document missing keyboard shortcuts in README The marketing intro mentioned `5`, `K`, and `Ctrl+Shift+R` but those never appeared in the Keyboard Shortcuts table. The `multi-agency-sar` scenario was also missing from the REST scenarios list, and the camera presets (`Shift+1..5`) plus the drone-strip cycling (`[`/`]`) were undocumented. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: correct wwwroot description (not committed) The Project Layout entry claimed wwwroot/ is "committed for zero-install deploys", but `git ls-files src/ResQ.Viz.Web/wwwroot/` returns 0 files and `.gitignore` excludes index.html, assets/, and .vite/. The zero-install path is actually the CI artifact `viz-wwwroot-{sha}` produced by ci.yml's client/build job, not anything in the repo. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: split long WebGPU sensor primitive sentence Addresses gemini-code-assist review feedback on PR #89 — the "voxelizes ... and serves ..." compound was a single 72-word sentence. Splitting at the rebuild-trigger clause keeps the trigger conditions visible while letting the LoS/LiDAR purpose start a fresh sentence. Backticks around `peakSlotDepth`, `raysOutsideWorld`, and `i` were already present in the source; only the bot's suggestion block had stripped them. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 participant
Summary
README was written before the .NET 10 / Vite 8 / TS 6 upgrade and predates the entire WebGPU sensor arc (PRs #66–#87). Bringing it back into sync.
Changes
.NET 9→10,Three.js r175→0.184,TS 5 + Vite 6→TS 6 + Vite 8; new rows for the WebGPU sensor primitive and Vitest frontend tests.webgpu/(device, sensors, registry, world, brickmap, los, lidar, rays, shaders/) and__tests__/, plus the newsensorStatsOverlay.ts.ifor the sensor stats overlay.2024 ResQ Technologies Ltd.→2026 ResQ Systems, Inc.— matches the SPDX headers across the codebase.Note
Originally tried to push directly to main (you said "straight to default" 😄), but branch protection rejected —
requiredstatus check + PR-only rule. So this is the PR path.🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation