[DOCS] restructure navigation #2519
Conversation
MrPowers
force-pushed
the
restructure-navigation
branch
from
34e416c to
cb5eb38
Compare
MrPowers
force-pushed
the
restructure-navigation
branch
from
cb5eb38 to
fe26d65
Compare
docs/sedonaspark.md
Outdated
| === "SBT" | ||
|
|
||
| ``` | ||
| libraryDependencies += "org.apache.sedona" % "sedona-common" % "{{ sedona.current_version }}" |
There was a problem hiding this comment.
the installation of SedonaSpark is much more complex than this. Should we instead direct users to the installation page instead?
There was a problem hiding this comment.
Yea, I just removed these summary install instructions. Users can easily navigate to the "Install" section, which includes full details for each runtime.
There was a problem hiding this comment.
Pull request overview
This PR restructures the documentation navigation to organize content by Sedona runtime (SedonaDB, SedonaSpark, SedonaFlink, SedonaSnow) rather than by platform. Three new landing pages are introduced for SedonaSpark, SedonaFlink, and SedonaSnow, and the navigation hierarchy is reorganized to group installation, programming guides, and API documentation under each runtime.
Key Changes:
- Reorganized navigation from platform-centric to runtime-centric structure
- Added three new documentation landing pages (sedonaspark.md, sedonaflink.md, sedonasnow.md)
- Updated homepage deployment section links and positioning
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Restructured navigation hierarchy to organize by runtime (SedonaSpark, SedonaFlink, SedonaSnow) instead of platform |
| docs/sedonaspark.md | New landing page describing SedonaSpark features and usage examples |
| docs/sedonasnow.md | New landing page describing SedonaSnow integration with Snowflake |
| docs/sedonaflink.md | New landing page describing SedonaFlink for streaming geospatial processing |
| docs-overrides/main.html | Updated deployment section links and moved section earlier in the page |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
2 participants
Did you read the Contributor Guide?
Yes, I have read the Contributor Rules and Contributor Development Guide
No, I haven't read it.
Is this PR related to a ticket?
[DOCS] my subjectWhat changes were proposed in this PR?
Updates the documentation structure.
How was this patch tested?
Tested locally.
Did this PR include necessary documentation updates?