docs(examples): hero chip on xView + h3-rasterize docs pages#43
Merged
Conversation
The example notebooks + READMEs got hero diagrams in #42, but the docs-site pages (notebooks/xview, notebooks/h3-rasterize) were missed. Embed each diagram after the intro paragraph (matching eo-series.mdx + the README placement). Includes the README chip-position tweaks for both examples. Co-authored-by: Isaac
The folium .explore() multi-layer map embeds Leaflet JS, which GitHub's notebook viewer won't run (shows a "Make this Notebook Trusted" placeholder). Switch that cell to a static matplotlib overlay (cells_as_gdf.plot + grid_gdf.boundary) so it renders on GitHub + the docs, and add a note on the choice + the interactive (.explore()) alternative for Databricks/trusted Jupyter. Stale folium output cleared (re-run on a cluster to materialize the static PNG). Co-authored-by: Isaac
Relative image paths don't resolve in the Databricks notebook UI, so the hero banners showed broken there. Point the eo-series (01-04) + xView banners at https://raw.githubusercontent.com/databrickslabs/geobrix/main/resources/images/... so they render in Databricks, GitHub, and the docs alike. (h3-rasterize handled separately in the re-executed copy.) Co-authored-by: Isaac
Re-executed copy: the shared-canvas overlay is the static matplotlib render (renders on GitHub with a real PNG output, no folium "trust notebook" placeholder), and the hero banner uses the absolute raw.githubusercontent.com URL so it shows in Databricks. Co-authored-by: Isaac
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #42: the example notebooks and READMEs got hero pipeline diagrams there, but the docs-site pages for two examples were missed. This adds the chip image to:
docs/docs/notebooks/xview.mdx→xview-clipping.pngdocs/docs/notebooks/h3-rasterize.mdx→h3-rasterize.pngEach is embedded after the intro paragraph (before the View on GitHub tip), matching
eo-series.mdxand the README placement. Also includes the README chip-position tweaks for both examples.The diagram PNGs already landed in #42 (
resources/images/{xview-clipping,h3-rasterize}.png); this only references them.Testing
../../../resources/images/*.pngpaths resolve — same pattern as the eo-series pages); no broken links or MDX errors.This pull request and its description were written by Isaac.
Also: GitHub-renderable shared-canvas map (h3 demo)
The h3 notebook's "shared canvas over the cells" map used folium
.explore(), which embeds Leaflet JavaScript that GitHub's notebook viewer won't execute (it shows a "Make this Notebook Trusted" placeholder). Switched that cell to a static matplotlib overlay (cells_as_gdf.plot+grid_gdf.boundary) so it renders on GitHub + the docs, with a short note on the choice and the interactive.explore()alternative for Databricks / a trusted local Jupyter. The stale folium output was cleared — re-run on a cluster to materialize the static PNG.