[FEATURE] Add Ibis example page#373
Conversation
Signed-off-by: John McCall <john@overturemaps.org>
🗺️ OMF Docs previews are live!
Auto-gen schema site is now available. This is an early preview of a future workflow where we will automatically generate and publish reference docs for the Overture Maps Format schema with every change to the schema repo. Note ♻️ This preview updates automatically with each push to this PR. |
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
There was a problem hiding this comment.
Pull request overview
Adds a new Docusaurus Example page showing how to query Overture GeoParquet data with Ibis + DuckDB, and updates sidebar management to use autogenerated ordering where alphabetical ordering is acceptable.
Changes:
- Add a new
Ibisexample page underdocs/examples/. - Convert the
Data MirrorsandExamplessidebar sections toautogenerateditems and setsidebar_positionto keep overview pages first. - Update the Examples landing page to render its list dynamically from the sidebar category.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Switch Data Mirrors and Examples to autogenerated sidebar items; keep schema index first. |
| docs/guides/index.mdx | Minor formatting/indentation adjustment in the guides list. |
| docs/getting-data/data-mirrors/index.mdx | Add sidebar_position: 0 to keep the overview first under autogenerated ordering. |
| docs/examples/index.mdx | Replace the hardcoded example links with a dynamically-generated list from the sidebar. |
| docs/examples/ibis.mdx | Add a new Ibis + DuckDB + Lonboard example page for querying Overture data. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| import { useCurrentSidebarCategory } from '@docusaurus/plugin-content-docs/client'; | ||
|
|
||
| export function ExamplesList() { | ||
| const category = useCurrentSidebarCategory(); | ||
| return ( | ||
| <ul> | ||
| {category.items.map((item) => ( | ||
| <li key={item.href}> | ||
| <strong><a href={item.href}>{item.label}</a></strong> |
| :::info | ||
| This example requires `duckdb>=1.1.1` for GeoParquet support. See the [Ibis blog post](https://ibis-project.org/posts/ibis-overturemaps/index.html) for an extended walkthrough including visualization with Lonboard. | ||
| ::: |
Closes #104 by adding an Example page for using Overture data with Ibis.
This change also converts the management of some sub-menus to be dynamically generated where the default order of alphabetical is sufficient (some sub-menus have intentional ordering).