docs: highlight the 1,000+ browser-based geoprocessing tools - #1648
Conversation
The toolbox ships 1,009 runnable tools but the docs never said so, and several pages still described it as sidecar-backed and desktop-only. It has run in WebAssembly since v1.7 and carries no mobile gate, so the full set is available on the web and Android builds too.
📝 WalkthroughWalkthroughThis documentation update describes the 1,000+ tool Whitebox toolbox, WebAssembly-first execution, optional Python sidecar use, and availability across web, desktop, Android, and iOS. ChangesWhitebox WebAssembly documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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. Comment |
🔍 Cloudflare PR preview
|
There was a problem hiding this comment.
Pull request overview
This PR updates the public docs to prominently describe GeoLibre’s Whitebox/“geoprocessing toolbox” as a browser-capable (WASM) feature set, and corrects multiple pages that previously implied the toolbox was sidecar-backed and desktop-only.
Changes:
- Adds prominent “1,000+ geoprocessing tools” messaging (README + docs landing/features pages), including a new README section with screenshot + category breakdown.
- Rewrites the Processing user guide’s toolbox section to explain WASM vs sidecar execution, category browsing, and
?tool=deep links. - Updates Android/iOS/downloads/tutorial docs to remove “Whitebox requires sidecar / hidden on mobile” claims.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds a new geoprocessing section and prominent “1,000+ tools” positioning. |
| docs/user-guide/processing.md | Rewrites the toolbox section to describe WASM/sidecar behavior and deep-linking. |
| docs/tutorials/index.md | Updates tutorial prerequisites to clarify toolbox availability in-browser. |
| docs/ios.md | Corrects iOS feature gating to keep Whitebox available on mobile. |
| docs/index.md | Updates homepage feature card messaging to highlight the toolbox as WASM-based. |
| docs/features.md | Expands feature list bullets for the toolbox and its capabilities. |
| docs/downloads.md | Updates download notes and Android limitations to exclude Whitebox from sidecar-only tooling. |
| docs/architecture.md | Corrects the sidecar’s role and documents Whitebox’s default WASM execution. |
| docs/android.md | Corrects Android capability list and mobile gating to keep Whitebox available. |
Suppressed comments (1)
README.md:49
- This table hardcodes per-category tool counts (summing to 1,009). That contradicts the PR description’s intent to keep docs from going stale when the Whitebox catalog changes; the next catalog regen will require manual edits here.
| Category | Tools | Examples |
| --- | --- | --- |
| **Vector** | 280 | overlays, buffers, joins, cleaning, topology, generalization |
| **Raster** | 232 | algebra, filters, reclassification, zonal and focal statistics |
| **Remote sensing** | 154 | spectral indices, band math, classification, change detection |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Leads with the visual demos before the toolbox breakdown.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/downloads.md`:
- Around line 62-64: Update the tool runtime description in downloads.md to
distinguish the browser-based Whitebox WebAssembly engine from sidecar engines:
state that browser Whitebox runs without Python, while sidecar-based Whitebox
and AI Segmentation require sidecar support; retain the Python requirement for
Raster and Conversion.
In `@docs/index.md`:
- Around line 59-61: Align the conversion-support documentation with actual
behavior: update docs/index.md lines 59-61 to avoid claiming FlatGeobuf and COG
conversion runs in the browser, and document the sidecar requirement
consistently with the processing guide’s FlatGeobuf, COG, shapefile, GeoPackage,
and PMTiles outputs. Update docs/features.md line 252 to state that the GeoLibre
Processing conversion submenu is hidden on mobile.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: e9afb299-5eb1-4ecd-b0c3-3e8634ca59cf
📒 Files selected for processing (9)
README.mddocs/android.mddocs/architecture.mddocs/downloads.mddocs/features.mddocs/index.mddocs/ios.mddocs/tutorials/index.mddocs/user-guide/processing.md
- Drop the exact tool count from both screenshot alt texts so they do not drift when the catalog is regenerated (Copilot). - Give the projection category an explicit count, matching every other category in the features list (Claude). - Correct the Mac App Store wording: the Run locally checkbox is wrapped in !IS_MAS_BUILD, so it is absent there rather than pre-checked (Claude). - List AI Segmentation among the sidecar tools in the Windows portable note (CodeRabbit). - Clarify that the Conversion menu runs client-side in the browser or on the sidecar on desktop, so it is not read as browser-only (CodeRabbit).
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 88: Update the image alternative text in the README to replace the
hard-coded “1,009 tools” count with “1,000+ tools” or omit the count while
retaining the description of the selected Regularize Building Footprints tool.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Code reviewI fact-checked this docs-only PR against the actual source it describes ( Bugs: None found. Security: None found — no code changes, no secrets, no injectable content. Performance: Not applicable — docs-only change. Quality:
CLAUDE.md: No violations — this PR only touches No inline comments posted — I did not find defects rising to a level worth flagging. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/downloads.md`:
- Around line 62-65: Update the optional Python sidecar tools documentation in
the browser execution section to separate Conversion from raster and AI
Segmentation, explicitly stating that Conversion can run in the browser without
Python while retaining the Python requirement for the other sidecar tools and
the existing WebAssembly toolbox description.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 70d8dedf-96f0-47ca-a0eb-3105093311df
📒 Files selected for processing (5)
README.mddocs/downloads.mddocs/features.mddocs/index.mddocs/user-guide/processing.md
🔍 GitHub Pages PR preview
|
Summary
?tool=deep links.geolibre-wasmis bumped and the catalog is regenerated.Test plan
mkdocs build --strictpasses with no warnings; the new#geoprocessing-toolboxanchor and its inbound links resolve in the rendered HTMLpre-commit run --files <the nine changed files>passes, including thenpm-buildhookwhitebox-menu-catalog.ts, matching the "All (1009)" filter shown in the toolbox screenshotProcessingDialog.tsx(WASM default off the sidecar) andProcessingMenu.tsx(no!mobilegate on the toolbox)Summary by CodeRabbit
New Features
Documentation