Clean up outdated README #44

Merged

igai-agent-bot merged 1 commit from openhands/readme-cleanup into main

2026-07-14 22:04:27 +00:00

igai-agent-bot commented

2026-07-14 17:02:57 +00:00

Member

Summary

The README was heavily out of date — it described the repo as "Hello-World boilerplate" rendering random colors, used the wrong package name (@igasset/viewer-react instead of @indigocode-internal/igasset-viewer-react), listed only 3 of ~40+ exports, showed nonexistent <IgviewerCanvas> props, and omitted entire sections (testing, igpack bundles, serving igpacks, etc.).

Changes

Fix package name: @igasset/viewer-react → @indigocode-internal/igasset-viewer-react throughout (published scope is @indigocode-internal on the Forgejo NPM registry)
Remove stale status banner: the repo now has full texture/geometry inspectors, observable filestore, and igpack loading — no longer "Hello-World boilerplate"
Fix <IgviewerCanvas> props in all examples: width/height → style/className (the canvas auto-sizes to its container)
Update component export table to include texture inspector, geometry inspector, metadata filters, and useFilestoreState hook
Update demo description: threading selector, filestore viewer, upload panel, inspector modals — no longer "two canvases side by side"
Add missing scripts: build:wasm:configure, build:wasm:debug, build:wasm:debug:configure, dev:debug, format, format:check
Add Testing section: jsdom unit tests + Playwright browser integration + CI workflow description
Add Regenerating igpack bundles section: documents wasm/gen_plans/, raw_assets/, and the igasset-gen / igpack-bundle commands
Add Serving igpacks section: documents that dist/igpack/ must be served at /igpack/ on the host
Add usage examples for texture inspector, geometry inspector, and filestore management
Add Provider options + context value reference tables (including device, errorFallback, capabilities, filestore)
Expand Layout section: raw_assets/, wasm/igpacks/, wasm/gen_plans/, wasm/extern/
Fix igasset repo link: sessamekesh/igasset → indigocode/igasset

What was preserved (still accurate)

The entire bundler matrix table (Vite, Webpack, RSPack, etc.)
The threading / COOP+COEP section with all host-specific header snippets
The manual escape hatch (wasmUrl prop) explanation
The CMake presets & IDE integration section (clangd, VSCode, Cursor)
The prerequisites and one-time setup instructions

This PR was created by an AI agent (OpenHands) on behalf of igai-agent-bot.

## Summary The README was heavily out of date — it described the repo as "Hello-World boilerplate" rendering random colors, used the wrong package name (`@igasset/viewer-react` instead of `@indigocode-internal/igasset-viewer-react`), listed only 3 of ~40+ exports, showed nonexistent `<IgviewerCanvas>` props, and omitted entire sections (testing, igpack bundles, serving igpacks, etc.). ## Changes - **Fix package name**: `@igasset/viewer-react` → `@indigocode-internal/igasset-viewer-react` throughout (published scope is `@indigocode-internal` on the Forgejo NPM registry) - **Remove stale status banner**: the repo now has full texture/geometry inspectors, observable filestore, and igpack loading — no longer "Hello-World boilerplate" - **Fix `<IgviewerCanvas>` props** in all examples: `width`/`height` → `style`/`className` (the canvas auto-sizes to its container) - **Update component export table** to include texture inspector, geometry inspector, metadata filters, and `useFilestoreState` hook - **Update demo description**: threading selector, filestore viewer, upload panel, inspector modals — no longer "two canvases side by side" - **Add missing scripts**: `build:wasm:configure`, `build:wasm:debug`, `build:wasm:debug:configure`, `dev:debug`, `format`, `format:check` - **Add Testing section**: jsdom unit tests + Playwright browser integration + CI workflow description - **Add Regenerating igpack bundles section**: documents `wasm/gen_plans/`, `raw_assets/`, and the `igasset-gen` / `igpack-bundle` commands - **Add Serving igpacks section**: documents that `dist/igpack/` must be served at `/igpack/` on the host - **Add usage examples** for texture inspector, geometry inspector, and filestore management - **Add Provider options + context value reference tables** (including `device`, `errorFallback`, `capabilities`, `filestore`) - **Expand Layout section**: `raw_assets/`, `wasm/igpacks/`, `wasm/gen_plans/`, `wasm/extern/` - **Fix igasset repo link**: `sessamekesh/igasset` → `indigocode/igasset` ## What was preserved (still accurate) - The entire **bundler matrix** table (Vite, Webpack, RSPack, etc.) - The **threading / COOP+COEP** section with all host-specific header snippets - The **manual escape hatch** (`wasmUrl` prop) explanation - The **CMake presets & IDE integration** section (clangd, VSCode, Cursor) - The **prerequisites** and one-time setup instructions --- _This PR was created by an AI agent (OpenHands) on behalf of igai-agent-bot._

igai-agent-bot added 1 commit

2026-07-14 17:02:57 +00:00

Clean up outdated README

Test / unit (pull_request_target) Successful in 18s

Details

Test / build-wasm (pull_request_target) Successful in 3m22s

Details

Test / browser (pull_request_target) Successful in 17s

Details

15d8b0e31c

- Fix package name: @igasset/viewer-react → @indigocode-internal/igasset-viewer-react
  (published scope is @indigocode-internal on the Forgejo NPM registry)
- Remove stale 'Hello-World boilerplate' status banner — the repo now has
  full texture/geometry inspectors, observable filestore, and igpack loading
- Fix <IgviewerCanvas> props in all examples (width/height → style/className)
- Update component export list to include texture inspector, geometry
  inspector, metadata filters, and useFilestoreState hook
- Update demo description (threading selector, filestore viewer, upload
  panel, inspector modals — no longer 'two canvases side by side')
- Add missing scripts: build:wasm:configure, build:wasm:debug,
  build:wasm:debug:configure, dev:debug, format, format:check
- Add Testing section (jsdom unit tests + Playwright browser integration)
- Add Regenerating igpack bundles section
- Add Serving igpacks section (dist/igpack/ must be served at /igpack/)
- Add usage examples for texture/geometry inspectors and filestore management
- Add Provider options + context value reference tables
- Expand Layout section (raw_assets, wasm/igpacks, wasm/gen_plans, wasm/extern)
- Fix igasset repo link (sessamekesh → indigocode)

Co-authored-by: openhands <openhands@all-hands.dev>