Skip to content

[DOCS] Add bathymetry guide page documenting deeper-than coverage semantics - #480

Merged
Dana Bauer (danabauer) merged 8 commits into
mainfrom
atiannicelli-bathymetry-docs
Aug 12, 2026
Merged

[DOCS] Add bathymetry guide page documenting deeper-than coverage semantics#480
Dana Bauer (danabauer) merged 8 commits into
mainfrom
atiannicelli-bathymetry-docs

Conversation

@atiannicelli

@atiannicelli Alex Iannicelli (atiannicelli) commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a dedicated guide page for the base theme's bathymetry feature type, documenting the new coverage semantics introduced by tf-data-platform#4780.

Closes #479

Changes

  • New docs/guides/base/bathymetry.mdx:
    • What bathymetry features are and their ETOPO1/GLOBathy sources
    • The stacked depth-level model: depth = d covers all water deeper than d meters; levels nest and land is not covered
    • Consumer guidance: rendering stacked levels with sort_key, extracting disjoint depth bands, ~1° grid-chipped geometries and spatial filtering benefits
  • docs/guides/base/index.mdx: link the new page from the overview and the bathymetry feature type description
  • sidebars.js: add the page to the Base category

Testing

  • npx markdownlint clean on the new page
  • Full npm run build passes (links and sidebar validated)

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>
@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

🗺️ OMF Docs previews are live!

🆕 Auto-gen schema site (beta) https://staging.overturemaps.org/docs/pr/480/index.html
🗂️ Auto-gen schema ref main@bd85f08
🌍 Repo schema site https://staging.overturemaps.org/docs/pr/480-no-autogen/index.html
🕐 Updated Aug 12, 2026 20:33 UTC
📝 Commit e9d6b23

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>
@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
JAVASCRIPT_ES Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
SQLFLUFF Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

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

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 Bathymetry guide 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_RELEASE token (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.

Comment thread docs/guides/base/bathymetry.mdx Outdated
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

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.

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

Comment thread docs/guides/base/bathymetry.mdx Outdated
Comment thread docs/guides/base/bathymetry.mdx Outdated
Comment thread docs/guides/base/bathymetry.mdx Outdated
Comment thread docs/guides/base/bathymetry.mdx Outdated
Comment thread docs/guides/base/bathymetry.mdx
Comment thread docs/guides/base/bathymetry.mdx Outdated
Comment thread docs/guides/base/bathymetry.mdx Outdated
Comment thread docs/guides/base/bathymetry.mdx Outdated
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>
@danabauer
Dana Bauer (danabauer) merged commit 8113e06 into main Aug 12, 2026
22 checks passed
@danabauer
Dana Bauer (danabauer) deleted the atiannicelli-bathymetry-docs branch August 12, 2026 21:07
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.

[DOCS] Document bathymetry and the new deeper-than coverage semantics

5 participants