[DOCS] Add bathymetry guide page documenting deeper-than coverage semantics - #480
Conversation
Documents the base theme bathymetry feature type: stacked depth levels, the coverage inversion introduced in tf-data-platform#4780, grid chipping, and rendering/query guidance. Links the new page from the base guide overview and sidebar. Refs #479 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Alex Iannicelli <atiannicelli@gmail.com>
🗺️ 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. The auto-gen schema site may contain incomplete or inaccurate information as we are still refining the generation process, so please compare against the repo schema site and refer to the official Overture documentation for authoritative information. Note ♻️ This preview updates automatically with each push to this PR. |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Alex Iannicelli <atiannicelli@gmail.com>
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 dedicated Base-theme guide page for bathymetry, documenting the “deeper-than” stacked-coverage semantics introduced by tf-data-platform#4780, and wires it into the docs navigation.
Changes:
- Added a new
Bathymetryguide page describing stacked depth-level semantics, pipeline inversion/chipping, and consumer guidance. - Linked the new page from the Base guide overview and expanded the Bathymetry feature-type description.
- Added the new page to the Docusaurus sidebar under the Base category.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sidebars.js | Adds guides/base/bathymetry to the Base section navigation. |
| docs/guides/base/index.mdx | Links to the new bathymetry page and summarizes the “deeper-than” semantics in the Base overview. |
| docs/guides/base/bathymetry.mdx | New detailed bathymetry guide page covering semantics, pipeline behavior, and access paths. |
Suppressed comments (1)
docs/guides/base/bathymetry.mdx:51
- The data-access paths use a
<release>placeholder, while the rest of the docs use the consistent__OVERTURE_RELEASEtoken (e.g.,docs/guides/base/index.mdx). Using the same token here makes copy/paste consistent across guides.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Alex Iannicelli <atiannicelli@gmail.com>
The flagged terms appear in generated schema reference docs as field names (websites), type names (Id), or intentional prose (snake case, key/value pairs), so exclude them rather than editing generated files. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Alex Iannicelli <atiannicelli@gmail.com>
…ry-docs Signed-off-by: Alex Iannicelli <atiannicelli@gmail.com> # Conflicts: # .github/linters/.textlintrc.json
Adam Lastowka (Rachmanin0xFF)
left a comment
There was a problem hiding this comment.
I left a lot of little nits, sorry... I needed a break from code for a minute. You can ignore any you think aren't worth your attention
Co-authored-by: Adam Lastowka <adamlastowka@gmail.com> Signed-off-by: Alex Iannicelli <atiannicelli@gmail.com>
Co-authored-by: Adam Lastowka <adamlastowka@gmail.com> Signed-off-by: Alex Iannicelli <atiannicelli@gmail.com>
Co-authored-by: Adam Lastowka <adamlastowka@gmail.com> Signed-off-by: Alex Iannicelli <atiannicelli@gmail.com>
Summary
Adds a dedicated guide page for the base theme's
bathymetryfeature type, documenting the new coverage semantics introduced by tf-data-platform#4780.Closes #479
Changes
docs/guides/base/bathymetry.mdx:depth = dcovers all water deeper thandmeters; levels nest and land is not coveredsort_key, extracting disjoint depth bands, ~1° grid-chipped geometries and spatial filtering benefitsdocs/guides/base/index.mdx: link the new page from the overview and the bathymetry feature type descriptionsidebars.js: add the page to the Base categoryTesting
npx markdownlintclean on the new pagenpm run buildpasses (links and sidebar validated)