GeoLibre

1,948 Commits 5 Branches 40 Tags

3 Commits

Include renames

Author	SHA1	Message	Date
Qiusheng Wu	38ed979d3b	docs: review the docs against the code and fix drift (#3008 ) * docs: review the docs against the code and fix drift Check every docs page against the current code and correct what no longer matches: menu paths and labels, plugin placement (most plugins now open in a docked panel), Cesium ion tokens being optional, desktop OAuth sign-in for sharing, browser project save/open, project schema fields, server and collaboration endpoints, Python and MCP APIs, and stale paths in the source-code deep dives. Fix the Spatial SQL tutorial's ST_Area_Spheroid query, which needs ST_FlipCoordinates for lat/lon axis order. Document the Settings sections that were listed but never described (Language, Appearance, Interface, Geocoding, AI Providers), and add the USGS NLDI and ArcGIS feature editing pages to the nav. * docs: keep the NLDI and ArcGIS editing pages out of the nav * Address CodeRabbit review feedback - collaboration.md: give both snapshot-cap defaults, 10 MB for the relay and 1 MB in the Docker Compose setup. - features.md, cesium-renderer.md: without an Ion token the globe still gets terrain from keyless Terrarium elevation (or a configured COG), not a bare ellipsoid (cesium-engine.ts enableWorldTerrain). * Address CodeRabbit review feedback - project-format.md: type blankBackgroundColor and selectedLayerId as string \| null, matching ProjectFile in packages/core/src/types.ts.	2026-10-06 19:03:19 -04:00
Qiusheng Wuandgithub-actions[bot]	5ecb05760e	docs: correct the user guide against the running app and add screenshots (#2112 ) * docs: correct the user guide against the running app and add screenshots Several pages had drifted from the shipped UI: the toolbar was documented as seven menus with Edit and View missing entirely, Add Data omitted ten entries, the plugin and style-type lists were from an older release, and the terrain tutorial claimed raster tools need the desktop app when eight of them have a browser engine. Every claim here was rechecked by driving the app, and the Browser panel, Model Builder, Dashboard, and the attribute table's own tools are now documented rather than only mentioned in the feature list. * fix(mkdocs): update GeoLibre Web link in documentation * Address Claude review feedback - Correct the `C` shortcut row: it toggles the review-comment tool and the pin lands where you click next, not at the map center. Also mention the shortcut in the Review comments section, which only documented the panel. - Give Managing Layers its own Layers-panel screenshot instead of reusing the full-workspace shot from Interface Overview, which did not match the alt text. * Address CodeRabbit review feedback - Name both projection-aware engines in the buffer tip. Python (Pyodide) runs the same GeoPandas path as the sidecar and is the one available on the web build, so pointing only at the sidecar sends web users nowhere. - Stop claiming every on-map-control plugin has a positioning submenu. Flight Simulator and SamGeo toggle directly, and Web Services and DGGS open a list of sub-plugins instead. * Update mkdocs.yml Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>	2026-08-26 02:48:06 +00:00
Qiusheng Wuandgiswqs	6c9f26dc1a	docs: add User Guide and Tutorials (complete v1.0 documentation roadmap) (#194 ) * docs: add User Guide and Tutorials, completing the v1.0 documentation roadmap Add a comprehensive feature-by-feature User Guide (interface, projects, adding data, layers, styling, attribute table, controls, processing, SQL workspace, data integrations, plugins, settings, embedding) and seven end-to-end Tutorials. Restructure the docs nav into User Guide, Tutorials, and Reference sections, link the new sections from the home page, and check off the final v1.0 roadmap item. Screenshots are hosted on Cloudflare R2 (data.geolibre.app/images) and referenced by URL, not committed to the repo. * docs: note the live demo is GitHub Pages-hosted, browser-only, and does not track users * docs: make sidebar section headers stand out (User Guide, Tutorials, Reference) * docs: align README and User Guide/Tutorials for consistency - Link the hosted User Guide and Tutorials from the README Documentation section - Standardize menu navigation to the arrow separator used by the rest of the docs - Fix SQL Workspace examples to use the dataset's real columns (NAME, POP_EST, GDP_MD_EST) and geometry column (geom), and bare-URL FROM, matching the in-app sample queries and the README * docs: refresh 'What GeoLibre does today' cards to current functionality Drop the removed sample-data plugin and surface the plugin marketplace; replace the stale 'roadmap toward DuckDB Spatial and a sidecar' processing card with the shipped Conversion menu and Whitebox toolbox; broaden the data-format and map-workspace cards to current sources, data-driven styling, sharing, and the on-map component tools. * chore: release v1.0.0 Bump all workspace packages, the Tauri desktop app (package.json, tauri.conf.json, Cargo.toml/Cargo.lock), and the Python sidecar to 1.0.0, and sync package-lock.json. Update the docs and README for the v1.0 release: mark v1.0 as current on the roadmap, retitle the README features section, rewrite the home page Project status for a stable v1.0, and refresh the v0.9.0 version labels in the architecture and project-format pages and the plugin manifest examples. * docs: add screenshots to text-only User Guide and tutorial pages Add dark-theme screenshots to Projects, Managing Layers, Styling Layers, Settings, Data Integrations, and Embedding & Sharing (every User Guide page now has at least one), plus the Add Vector panel in the Your First Map tutorial. Hosted on R2 and referenced by URL. * Address Claude and CodeRabbit review feedback - settings.md, projects.md, sharing-embedding.md: move the Share.GeoLibre API token to the Environment Variables section (it lives in the Environment tab, not Project Settings) and use the real field name; list the read-only Project file/format fields; fix "Restrict map bounds" and "Use Current View" labels - embedding.md, sharing-embedding.md: add iframe title and allow="fullscreen; geolocation"; escape & as & in iframe src attributes - embedding.md: note icon and icon-only as toolbar aliases - interface.md: separate the rotate (right-drag) and tilt (Ctrl/Cmd-drag) gestures - processing.md: note the menu order differs from the page grouping; note Union drops attributes; mark Vector to FlatGeobuf as Hilbert-sorted - cloud-native-data.md: clarify the Stream GeoParquet hint (spatial/Hilbert row-group sorting, not a bounding-box column) - plugins.md: manifests allow HTTPS or HTTP on loopback, not HTTPS-only - spatial-sql.md: note the sample columns are Natural Earth fields - extra.css: comment that the nav selectors target Material internals (9.x) * Address second round of Claude review feedback - spatial-sql.md: note ST_Area returns square degrees on EPSG:4326 data (ranking is valid; use ST_Area_Spheroid for km2) - spatial-sql.md: clarify the bare-URL FROM shorthand is a SQL Workspace convenience, not standard DuckDB CLI syntax * Address third round of Claude review feedback - spatial-sql.md: note the sample file's geometry column is `geom` and show DESCRIBE SELECT * FROM 'url' to discover columns in other datasets * Address fourth round of Claude review feedback - vector-analysis.md: mirror the Union "attributes are not preserved" caveat from processing.md (verified: both the Turf.js client and the GeoPandas sidecar drop attributes for Union) * Address Claude review feedback (round 6) - processing.md: note Intersection merges attributes from both layers and Difference keeps input attributes (verified in vector-tools.ts) - data-integrations.md: move GeoAgent out of "Time series and comparison" into its own "AI analysis" section - map-controls.md: correct the tilt gesture description (Ctrl/Cmd-drag tilts into a perspective view, not a 3D look-around mode) - adding-data.md: note that GeoParquet Layer opens the same Add Vector panel as Vector Layer * Address review feedback: soften the live-demo "secure" claim - embedding.md, index.md: replace the absolute "it is secure" assertion with concrete, verifiable statements (no analytics, no server account, client-side processing, no tracking), per maintainer decision and two bot reviews * Address Claude review feedback: sync Union note with the tutorial - processing.md: add "on either engine" to the Union attribute note so it matches the wording in vector-analysis.md --------- Co-authored-by: giswqs <giswqs@users.noreply.github.com>	2026-06-09 22:19:48 -04:00

Author

SHA1

Message

Date

Qiusheng Wu

38ed979d3b

docs: review the docs against the code and fix drift (#3008 )

* docs: review the docs against the code and fix drift

Check every docs page against the current code and correct what no
longer matches: menu paths and labels, plugin placement (most plugins
now open in a docked panel), Cesium ion tokens being optional, desktop
OAuth sign-in for sharing, browser project save/open, project schema
fields, server and collaboration endpoints, Python and MCP APIs, and
stale paths in the source-code deep dives.

Fix the Spatial SQL tutorial's ST_Area_Spheroid query, which needs
ST_FlipCoordinates for lat/lon axis order. Document the Settings
sections that were listed but never described (Language, Appearance,
Interface, Geocoding, AI Providers), and add the USGS NLDI and ArcGIS
feature editing pages to the nav.

* docs: keep the NLDI and ArcGIS editing pages out of the nav

* Address CodeRabbit review feedback

- collaboration.md: give both snapshot-cap defaults, 10 MB for the
  relay and 1 MB in the Docker Compose setup.
- features.md, cesium-renderer.md: without an Ion token the globe still
  gets terrain from keyless Terrarium elevation (or a configured COG),
  not a bare ellipsoid (cesium-engine.ts enableWorldTerrain).

* Address CodeRabbit review feedback

- project-format.md: type blankBackgroundColor and selectedLayerId as
  string | null, matching ProjectFile in packages/core/src/types.ts.

2026-10-06 19:03:19 -04:00

Qiusheng Wuandgithub-actions[bot]

5ecb05760e

docs: correct the user guide against the running app and add screenshots (#2112 )

* docs: correct the user guide against the running app and add screenshots

Several pages had drifted from the shipped UI: the toolbar was documented as
seven menus with Edit and View missing entirely, Add Data omitted ten entries,
the plugin and style-type lists were from an older release, and the terrain
tutorial claimed raster tools need the desktop app when eight of them have a
browser engine. Every claim here was rechecked by driving the app, and the
Browser panel, Model Builder, Dashboard, and the attribute table's own tools
are now documented rather than only mentioned in the feature list.

* fix(mkdocs): update GeoLibre Web link in documentation

* Address Claude review feedback

- Correct the `C` shortcut row: it toggles the review-comment tool and the
pin lands where you click next, not at the map center. Also mention the
shortcut in the Review comments section, which only documented the panel.
- Give Managing Layers its own Layers-panel screenshot instead of reusing
the full-workspace shot from Interface Overview, which did not match the
alt text.

* Address CodeRabbit review feedback

- Name both projection-aware engines in the buffer tip. Python (Pyodide)
runs the same GeoPandas path as the sidecar and is the one available on
the web build, so pointing only at the sidecar sends web users nowhere.
- Stop claiming every on-map-control plugin has a positioning submenu.
Flight Simulator and SamGeo toggle directly, and Web Services and DGGS
open a list of sub-plugins instead.

* Update mkdocs.yml

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

2026-08-26 02:48:06 +00:00

Qiusheng Wuandgiswqs

6c9f26dc1a

docs: add User Guide and Tutorials (complete v1.0 documentation roadmap) (#194 )

* docs: add User Guide and Tutorials, completing the v1.0 documentation roadmap

Add a comprehensive feature-by-feature User Guide (interface, projects,
adding data, layers, styling, attribute table, controls, processing, SQL
workspace, data integrations, plugins, settings, embedding) and seven
end-to-end Tutorials. Restructure the docs nav into User Guide, Tutorials,
and Reference sections, link the new sections from the home page, and check
off the final v1.0 roadmap item.

Screenshots are hosted on Cloudflare R2 (data.geolibre.app/images) and
referenced by URL, not committed to the repo.

* docs: note the live demo is GitHub Pages-hosted, browser-only, and does not track users

* docs: make sidebar section headers stand out (User Guide, Tutorials, Reference)

* docs: align README and User Guide/Tutorials for consistency

- Link the hosted User Guide and Tutorials from the README Documentation section
- Standardize menu navigation to the arrow separator used by the rest of the docs
- Fix SQL Workspace examples to use the dataset's real columns (NAME, POP_EST,
  GDP_MD_EST) and geometry column (geom), and bare-URL FROM, matching the
  in-app sample queries and the README

* docs: refresh 'What GeoLibre does today' cards to current functionality

Drop the removed sample-data plugin and surface the plugin marketplace; replace
the stale 'roadmap toward DuckDB Spatial and a sidecar' processing card with the
shipped Conversion menu and Whitebox toolbox; broaden the data-format and
map-workspace cards to current sources, data-driven styling, sharing, and the
on-map component tools.

* chore: release v1.0.0

Bump all workspace packages, the Tauri desktop app (package.json, tauri.conf.json,
Cargo.toml/Cargo.lock), and the Python sidecar to 1.0.0, and sync package-lock.json.

Update the docs and README for the v1.0 release: mark v1.0 as current on the
roadmap, retitle the README features section, rewrite the home page Project
status for a stable v1.0, and refresh the v0.9.0 version labels in the
architecture and project-format pages and the plugin manifest examples.

* docs: add screenshots to text-only User Guide and tutorial pages

Add dark-theme screenshots to Projects, Managing Layers, Styling Layers,
Settings, Data Integrations, and Embedding & Sharing (every User Guide page now
has at least one), plus the Add Vector panel in the Your First Map tutorial.
Hosted on R2 and referenced by URL.

* Address Claude and CodeRabbit review feedback

- settings.md, projects.md, sharing-embedding.md: move the Share.GeoLibre API
  token to the Environment Variables section (it lives in the Environment tab,
  not Project Settings) and use the real field name; list the read-only Project
  file/format fields; fix "Restrict map bounds" and "Use Current View" labels
- embedding.md, sharing-embedding.md: add iframe title and
  allow="fullscreen; geolocation"; escape & as &amp; in iframe src attributes
- embedding.md: note icon and icon-only as toolbar aliases
- interface.md: separate the rotate (right-drag) and tilt (Ctrl/Cmd-drag) gestures
- processing.md: note the menu order differs from the page grouping; note Union
  drops attributes; mark Vector to FlatGeobuf as Hilbert-sorted
- cloud-native-data.md: clarify the Stream GeoParquet hint (spatial/Hilbert
  row-group sorting, not a bounding-box column)
- plugins.md: manifests allow HTTPS or HTTP on loopback, not HTTPS-only
- spatial-sql.md: note the sample columns are Natural Earth fields
- extra.css: comment that the nav selectors target Material internals (9.x)

* Address second round of Claude review feedback

- spatial-sql.md: note ST_Area returns square degrees on EPSG:4326 data
  (ranking is valid; use ST_Area_Spheroid for km2)
- spatial-sql.md: clarify the bare-URL FROM shorthand is a SQL Workspace
  convenience, not standard DuckDB CLI syntax

* Address third round of Claude review feedback

- spatial-sql.md: note the sample file's geometry column is `geom` and show
  DESCRIBE SELECT * FROM 'url' to discover columns in other datasets

* Address fourth round of Claude review feedback

- vector-analysis.md: mirror the Union "attributes are not preserved" caveat from
  processing.md (verified: both the Turf.js client and the GeoPandas sidecar drop
  attributes for Union)

* Address Claude review feedback (round 6)

- processing.md: note Intersection merges attributes from both layers and
  Difference keeps input attributes (verified in vector-tools.ts)
- data-integrations.md: move GeoAgent out of "Time series and comparison" into
  its own "AI analysis" section
- map-controls.md: correct the tilt gesture description (Ctrl/Cmd-drag tilts into
  a perspective view, not a 3D look-around mode)
- adding-data.md: note that GeoParquet Layer opens the same Add Vector panel as
  Vector Layer

* Address review feedback: soften the live-demo "secure" claim

- embedding.md, index.md: replace the absolute "it is secure" assertion with
  concrete, verifiable statements (no analytics, no server account, client-side
  processing, no tracking), per maintainer decision and two bot reviews

* Address Claude review feedback: sync Union note with the tutorial

- processing.md: add "on either engine" to the Union attribute note so it matches
  the wording in vector-analysis.md

---------

Co-authored-by: giswqs <giswqs@users.noreply.github.com>

2026-06-09 22:19:48 -04:00