docs: minor docs site improvements#4855
Merged
Merged
Conversation
The changelog toctree used each page's full '# DataFusion Comet X.Y.Z Changelog' heading as its sidebar label, which was too long to fit in the nav. Override the toctree labels with just the version number while keeping the descriptive page headings.
The homepage spark-shell example omitted the off-heap memory configs that Comet requires and hard-coded the jar version as 0.16.0. Add spark.memory.offHeap.enabled and spark.memory.offHeap.size, and use the $COMET_VERSION placeholder so the version stays current across releases.
The article container was capped at a fixed 860px width, which left large empty gaps on either side and prevented wide content such as compatibility tables from using the available space. Remove the fixed cap so the content fills the space between the sidebars and grows as the window widens.
coderfender
approved these changes
Jul 7, 2026
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
2 participants
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.
Which issue does this PR close?
Closes #.
Rationale for this change
Follow-up polish for the docs site after the phase 1 design overhaul (#4353). This addresses a few small usability issues found while reviewing the rendered site.
What changes are included in this PR?
DataFusion Comet X.Y.Z Changelogto just the version number, so they fit in the navigation. The descriptive page headings are unchanged.spark-shellexample: it was missing the off-heap memory configs that Comet requires (spark.memory.offHeap.enabledandspark.memory.offHeap.size) and hard-coded the jar version as0.16.0. The version now uses the$COMET_VERSIONplaceholder so it stays current across releases.How are these changes tested?
Documentation-only changes. Verified by building the site locally with
sphinx-buildand reviewing the affected pages (changelog index, homepage, and compatibility pages) in the browser.