You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: DOC-1705: Overhaul the Introduction and Deephaven overview pages - #9091
Overhauls the two top-level Community docs pages, Introduction (intro.md) and Deephaven overview (conceptual/deephaven-overview.md), in Python and Groovy. It applies every DOC-1705 audit finding and the fixes from two full reviews (accuracy, structure, style).
Deephaven overview
Accuracy fixes:
Removed the Solace integration claim. Community has no Solace code. Arrow Flight is now described as a transport, not a columnar data source.
C++ is described as a client library, not code that runs inside table operations.
"Limitless joins" is now "Rich joins". Natural joins reject duplicate right keys, for example.
Replaced the undated "currently investing in" roadmap with a Next steps section that links the release notes.
The Groovy page was a copy of the Python page and never mentioned Groovy. It now lists Groovy as a server language and marks Python-only features "in Python sessions".
Other fixes:
"Interoperates with" seven products is now "exchanges data with many of them through shared formats".
XML is no longer listed as a built-in in-memory source.
The page no longer claims pandas and R build a DAG.
Enterprise fixes reach Community only for Community components.
Structure and style:
Real ### headings replace the comment-title pseudo-headings.
"Live dataframes" is now defined concretely, and repeated client-API lists are collapsed.
Added every-mention links, sentence case and straight quotes.
Rendered the QuickstartCTA the page imported but never showed.
Voice and value-proposition lines are kept on purpose: "groundbreaking", "unlocking countless new use cases", the Range heading, "the perfect fit", Wall Street expertise, "elephants in this room", the F1 analogy, "just works", and the dual-stack line.
Introduction
Removed the duplicate cheat-sheet entry, the unused imports and the authoring leftovers.
Fixed a typo and the "Go" capitalization.
The Python page imports the TaglineCarousel through the @site alias, matching the Groovy page.
Added the R client to the generated API documentation list.
Other
The sidebar label is now "Deephaven overview" in both languages.
The reason will be displayed to describe this comment to others. Learn more.
🟡 Changes recommended
Both language overviews imply subscribers receive every update cycle, but coalescing can discard intermediate states, so the wording must avoid promising per-cycle delivery.
Refreshes the Python and Groovy Community documentation entry pages to better explain Deephaven’s capabilities and guide readers to relevant resources.
Changes:
Reworks both overviews with clearer live-dataframe explanations, corrected integration claims, language-specific guidance, and actionable next steps.
Cleans up introduction pages, removes duplicate links and unused imports, and adds R client API documentation.
Standardizes overview titles and sidebar labels.
File
Description
docs/python/sidebar.json
Uses sentence case for the overview label.
docs/python/intro.md
Cleans up imports and refreshes guide and API links.
docs/python/conceptual/deephaven-overview.md
Reorganizes capabilities, corrects claims, and adds next steps.
docs/groovy/sidebar.json
Matches the updated overview label.
docs/groovy/intro.md
Refreshes navigation and API links, including R.
docs/groovy/conceptual/deephaven-overview.md
Mirrors the overview overhaul with Groovy-specific guidance.
The new Excel link points to deephaven/deephaven-excel-addin, which returns 404, leaving readers without an accessible integration reference. Replace it with a publicly accessible Excel integration guide or repository. The same link needs updating in docs/groovy/conceptual/deephaven-overview.md:41.
Re: the Copilot review on bc7cb20 ("Replace broken Excel integration link"): fixed in 813da05. deephaven/deephaven-excel-addin is a private repository and there is no public Excel add-in page to link instead, so both overviews now mention Excel without a link, as main did.
The linked time-series guide includes range_join, but RangeJoinOperation.java:113–118 explicitly restricts it to "static (not refreshing) inputs," so this statement overstates live-table support. Qualify the claim rather than applying it to the whole join family. Apply the same change in docs/groovy/conceptual/deephaven-overview.md:102.
Re: the Copilot review on 813da05 ("Qualify range_join's live-table support in the guides"): fixed in both languages. The Rich joins bullet now adds "Range joins are the exception: they currently require static tables.", matching the UnsupportedOperationException in RangeJoinOperation. Pushed together with a merge of main (03272c7).
The reason will be displayed to describe this comment to others. Learn more.
🟢 Approval recommended
No active review issues require resolution for the Python and Groovy documentation updates.
No open issues 🎉
Review effort: Balanced
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
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.
Overhauls the two top-level Community docs pages, Introduction (
intro.md) and Deephaven overview (conceptual/deephaven-overview.md), in Python and Groovy. It applies every DOC-1705 audit finding and the fixes from two full reviews (accuracy, structure, style).Deephaven overview
Accuracy fixes:
Structure and style:
###headings replace thecomment-titlepseudo-headings.QuickstartCTAthe page imported but never showed.Voice and value-proposition lines are kept on purpose: "groundbreaking", "unlocking countless new use cases", the Range heading, "the perfect fit", Wall Street expertise, "elephants in this room", the F1 analogy, "just works", and the dual-stack line.
Introduction
@sitealias, matching the Groovy page.Other
🤖 Generated with Claude Code