docs: add data products comparison table to Data Overview - #2848
Merged
Conversation
Compares RPC, Horizon, Hubble, and Galexie side by side with Type and Interface rows so readers can tell an API from a warehouse or export tool. Points the Horizon history footnote on the APIs page at the new table. Closes #1619.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a centralized comparison of Stellar’s four data products and links to it from the APIs overview.
Changes:
- Compares RPC, Horizon, Hubble, and Galexie capabilities.
- Adds hosting/history notes and a cross-reference from the APIs page.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
docs/data/README.mdx |
Adds the data-product comparison table. |
docs/data/apis/README.mdx |
Links to the expanded comparison. |
Suppressed comments (2)
docs/data/README.mdx:19
- This cell treats the default retention window as RPC's full capability, but archive-enabled RPC can serve complete ledger history through
getLedgers(docs/data/apis/rpc/admin-guide/data-lake-integration.mdx:6-10), and the provider page lists archive services (docs/data/apis/rpc/providers.mdx:10-29). The seven-day limit still applies by default and to the other endpoints, so please preserve that nuance rather than ruling out historical RPC access entirely.
| Historical data | ❌ About 7 days | ❌ 1 year\* | ✅ Full | ✅ Full |
docs/data/README.mdx:25
Testnet onlyomits SDF's Futurenet RPC endpoint:docs/data/apis/rpc/providers.mdx:45-46lists both SDF-hosted Futurenet and Testnet services. Since this row describes hosting coverage, name both networks (or say “Non-Mainnet”) to avoid implying that Futurenet is unavailable from SDF.
| Hosted by SDF | Testnet only | ✅ Deprecating | ✅ Public dataset | ❌\*\* |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
chowbao
approved these changes
Sep 10, 2026
Use mark-only or word-only rows to match the other comparison tables in the docs, drop the Run it yourself row where every cell was the same, and correct the SDF hosting cells: RPC is testnet and futurenet, Horizon is mainnet, testnet, and futurenet.
Contributor
Contributor
|
PR Preview: torn down |
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
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.
Closes #1619
What
Adds a Compare Data Products section to the Data Overview page (
docs/data/README.mdx) with one table across SDF's four data products: RPC, Horizon, Hubble, and Galexie. Type and Interface rows make it clear which are APIs and which are bulk historical data tools, followed by the feature rows from the existing RPC/Horizon table plus transaction submission and SDF hosting.Two footnotes cover the details that don't fit a cell: the SDF-hosted Horizon keeps one year of history and is nearing end-of-life, and SDF doesn't host a Galexie data lake but providers do. Rows are either all marks or all words to match the other comparison tables in the docs. A closing paragraph explains why Ingest SDK and Processors are not columns (they're libraries) and where third-party providers are listed.
Why
The APIs Overview compares only RPC and Horizon, then points at Hubble and Galexie in a footnote without comparing them. The Data Overview already introduces all four categories and tells readers to pick the right tool for their use case, so it's the natural home for a side-by-side view. This is option 1 from the discussion on #1619, which Leigh signed off on.
Other changes
docs/data/apis/README.mdx: the Horizon history footnote now links to the new table. The RPC/Horizon table itself is unchanged.routes.txtunchanged.Checks
pnpm buildpasses with no broken links (node 24).