Skip to content

docs: highlight the 1,000+ browser-based geoprocessing tools - #1648

Merged
giswqs merged 3 commits into
mainfrom
docs/highlight-geoprocessing-tools
Aug 2, 2026
Merged

docs: highlight the 1,000+ browser-based geoprocessing tools#1648
giswqs merged 3 commits into
mainfrom
docs/highlight-geoprocessing-tools

Conversation

@giswqs

@giswqs giswqs commented Aug 2, 2026

Copy link
Copy Markdown
Member

Summary

  • Highlight the geoprocessing toolbox across the README and docs: the checked-in catalog holds 1,009 runnable tool ids across nine categories (vector, raster, remote sensing, hydrology, terrain, LiDAR, conversion, network, projection), which was nowhere in the docs. Adds a README section with a screenshot and a per-category table, plus a rewritten "Geoprocessing toolbox" section in the Processing user guide covering the WASM/sidecar engine toggle, category browsing, and ?tool= deep links.
  • Correct stale engine and platform claims that contradicted the above. Several pages still described the toolbox as sidecar-backed and desktop-only, but it has run in WebAssembly since v1.7 and, unlike Raster/Conversion/AI Segmentation, carries no mobile gate in the Processing menu, so the full set is available on the web and Android builds. Fixed in the Processing guide, Architecture, Android, iOS, Downloads, and Tutorials index.
  • Prose uses "1,000+" rather than a hardcoded count so it does not go stale when geolibre-wasm is bumped and the catalog is regenerated.

Test plan

  • mkdocs build --strict passes with no warnings; the new #geoprocessing-toolbox anchor and its inbound links resolve in the rendered HTML
  • pre-commit run --files <the nine changed files> passes, including the npm-build hook
  • Tool count verified two ways: 1,009 unique unlocked ids in whitebox-menu-catalog.ts, matching the "All (1009)" filter shown in the toolbox screenshot
  • Platform claims verified against ProcessingDialog.tsx (WASM default off the sidecar) and ProcessingMenu.tsx (no !mobile gate on the toolbox)
  • Docs preview renders the screenshot and the category table correctly

Summary by CodeRabbit

  • New Features

    • Added documentation for 1,000+ browser-based WebAssembly geoprocessing tools.
    • Documented tool categories, search, browsing, deep links, processing history, and selectable execution engines.
    • Clarified availability across web, desktop, Android, and iOS without requiring Python for browser-based tools.
    • Added guidance on local data processing, optional Python-sidecar use, and related resources.
  • Documentation

    • Updated platform, architecture, download, tutorial, and processing guides with expanded capabilities and deployment details.

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.
Copilot AI review requested due to automatic review settings August 2, 2026 15:23
@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This documentation update describes the 1,000+ tool Whitebox toolbox, WebAssembly-first execution, optional Python sidecar use, and availability across web, desktop, Android, and iOS.

Changes

Whitebox WebAssembly documentation

Layer / File(s) Summary
Toolbox overview
README.md, docs/index.md
The documentation describes the 1,000+ browser-based Whitebox tools, categories, platforms, and processing inventory.
Processing workflow
docs/user-guide/processing.md, docs/features.md
The processing documentation covers tool sources, execution modes, navigation, parameters, outputs, shareable links, and processing history.
Execution model
docs/architecture.md, docs/downloads.md, docs/tutorials/index.md
The documentation identifies WebAssembly as the default Whitebox engine and describes optional Python sidecar execution.
Mobile availability
docs/android.md, docs/ios.md, docs/features.md, docs/downloads.md
Mobile documentation keeps Whitebox available through WebAssembly and lists local-process-dependent tools as unavailable.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • opengeos/GeoLibre#1581: Both changes cover Whitebox browser-based WASM execution and processing-tool engine restrictions.

Poem

A rabbit sees tools run bright,
WebAssembly guides their flight.
Python waits for native chores,
Whitebox opens many doors.
Clear docs mark each path just right.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the PR's main documentation change: highlighting 1,000+ browser-based geoprocessing tools.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/highlight-geoprocessing-tools

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

🔍 Cloudflare PR preview

Item Value
Site https://155784ee.geolibre-preview.pages.dev
Demo app https://155784ee.geolibre-preview.pages.dev/demo/
Commit 9d48af2

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Comment thread docs/user-guide/processing.md Outdated
Comment thread docs/features.md Outdated
Leads with the visual demos before the toolbox breakdown.
Comment thread docs/user-guide/processing.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between a551f7c and 9d48af2.

📒 Files selected for processing (9)
  • README.md
  • docs/android.md
  • docs/architecture.md
  • docs/downloads.md
  • docs/features.md
  • docs/index.md
  • docs/ios.md
  • docs/tutorials/index.md
  • docs/user-guide/processing.md

Comment thread docs/downloads.md Outdated
Comment thread docs/index.md Outdated
- 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).

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: be45e364-91d2-4bfb-9362-1d2069c48965

📥 Commits

Reviewing files that changed from the base of the PR and between 9d48af2 and a17b830.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Code review

I fact-checked this docs-only PR against the actual source it describes (whitebox-menu-catalog.ts, ProcessingMenu.tsx, ProcessingDialog.tsx) rather than just reading prose in isolation.

Bugs: None found.

Security: None found — no code changes, no secrets, no injectable content.

Performance: Not applicable — docs-only change.

Quality:

  • Verified the tool-count claims are accurate, not just self-consistent: counted { id: ... } entries directly from whitebox-menu-catalog.ts for Conversion (49), Hydrology (100), LiDAR (65), Network (26), and Projection (4) — all match the README table exactly, and the remaining four categories (Raster/Remote sensing/Terrain/Vector) sum to exactly the correct remainder (765) against the 1,009 total. High confidence the numbers are correct.
  • Verified the platform/engine claims against code: ProcessingMenu.tsx confirms Whitebox has no !mobile gate while Raster/Conversion/AI Segmentation do; ProcessingDialog.tsx confirms runLocal defaults to WASM in the browser and on the Mac App Store build, and to the sidecar on desktop, and that the "Run locally" checkbox is hidden (!IS_MAS_BUILD) exactly as the new processing.md prose describes. High confidence.
  • Minor stylistic nit (not worth blocking): docs/features.md's "Nine categories" line mixes tilde-approximated counts (~280, ~230, …) with one exact, un-tilded value (projection (4)), and only the first entry carries the word "tools". Cosmetic only — low confidence this needs fixing.
  • No broken anchors: confirmed nothing else in docs/ links to the old #whitebox heading, which was renamed to #geoprocessing-toolbox.

CLAUDE.md: No violations — this PR only touches README.md and docs/*.md, none of the generated/mirrored files CLAUDE.md calls out (menu catalog, distance-param lists, etc.) were modified, and no code-adjacent conventions apply here.

No inline comments posted — I did not find defects rising to a level worth flagging.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between a17b830 and 518962c.

📒 Files selected for processing (5)
  • README.md
  • docs/downloads.md
  • docs/features.md
  • docs/index.md
  • docs/user-guide/processing.md

Comment thread docs/downloads.md
@giswqs
giswqs merged commit a3781ce into main Aug 2, 2026
61 checks passed
@giswqs
giswqs deleted the docs/highlight-geoprocessing-tools branch August 2, 2026 15:41
@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

🔍 GitHub Pages PR preview

Item Value
Site Deploy failed. See the job log.
Demo app Unavailable
Commit 9d48af2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants