Repository navigation
Link each FAQ answer to the docs page that covers it - #219
Merged
Merged
Conversation
/faq answers the questions people ask search engines and AI assistants about Vortex: what it is, how it compares to Parquet, when to use it, why it is fast, whether the format is stable, how to install it, who uses it, who maintains it, and where to get help. The comparison with Parquet carries the homepage's figures from bench, and the adopters and install commands come from the homepage's own lists, so the page cannot fall behind them. The page draws the design system's Article card, as a blog post does. The footer links to it on both sites, the sitemap lists it, llms.txt links it, and llms-full.txt gives it in full. verify checks that its FAQPage data has one question per heading, and the axe run covers it. Signed-off-by: Will Manning <will@willmanning.io>
Each figure now names its source and class: bench's results are public benchmarks, and the GPU figure is an internal measurement, explained in plain words after the list. The size tradeoff carries bench's number. No sentence is over 25 words, the license line no longer repeats, and the adopters are a list. Signed-off-by: Will Manning <will@willmanning.io>
… as such The answer to "Should I use Vortex instead of Parquet?" now lists only the workloads where bench's newest verdict says Vortex is faster, names any where Parquet is faster, and points to bench when its results could not be read. The adopters answer, and the matching llms.txt line, now say the list holds adopters and the projects Vortex works with. Signed-off-by: Will Manning <will@willmanning.io>
The lead-in says "For most workloads, yes" only when Vortex wins more than half the speed panels, and "It depends on the workload" when it wins fewer. Parquet's size advantage drops out only when bench measures Vortex's files as smaller or the same size; without a size verdict the answer points to bench and keeps storage cost in the last sentence. Signed-off-by: Will Manning <will@willmanning.io>
…arisons A new answer says how Lance differs: a table format and a file format with one name, with indexes and versions, where Vortex is only a file format that table formats store. It lists bench's newest verdicts for Vortex against Lance, and how each project is governed. /faq now reads bench's TPC-H SF10 scores on DataFusion (morePanelsFrom), and lists them after ClickBench in both comparisons. The homepage table is unchanged, and does not depend on them. Signed-off-by: Will Manning <will@willmanning.io>
The sentence on proposed table formats ended "has a proposal to." It now says "has a proposal to store tables in Vortex files", and stands on its own when no shipped table format is listed. Signed-off-by: Will Manning <will@willmanning.io>
The Lance answer now says how the Vortex charter changes (two thirds of the Technical Steering Committee and LF Projects' approval), and that LanceDB, a private company, holds Lance's name and code rather than an independent foundation. Signed-off-by: Will Manning <will@willmanning.io>
…ents The governance answer now lists the organizations Vortex's committers and maintainers are affiliated with, and links the LF AI & Data press release and the post on donating Vortex. Signed-off-by: Will Manning <will@willmanning.io>
Signed-off-by: Will Manning <will@willmanning.io>
The answer said each release from 0.36.0 on reads files from any other release from 0.36.0 on. The docs guarantee only that a release reads files from earlier releases; an older reader needs the writer to target an edition it supports. The answer now says so and links the docs' versioning page. Signed-off-by: Will Manning <will@willmanning.io>
The FAQ now names the libraries and engines the docs cover (C and C++, Ray, Pandas, Polars, and PyArrow), says that Vortex keeps zone maps rather than secondary indexes, and links each answer to the docs page that covers it: the quickstarts, the engine guides, the concepts, stats pruning, the install page, and the contributing guide. Signed-off-by: Will Manning <will@willmanning.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codex Review Summary: ❌ FailedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Signed-off-by: Will Manning <will@willmanning.io> # Conflicts: # src/lib/faq.ts
🔦 Lighthouse audit
Run |
The answer said Vortex has no secondary indexes. A Vortex file holds zone maps by default (the default writer's ZonedStrategy), and a custom layout can add other indexes. What a table format adds is indexes outside the file, such as a vector index over a table, and versions. Signed-off-by: Will Manning <will@willmanning.io>
This branch was successfully deployed
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.
What changes
On vortex.dev/faq, each answer now links to the docs.vortex.dev page that covers it: the quickstarts, the engine guides, the concepts, stats pruning, the install page, and the contributing guide. "What is Vortex?" names every library and engine the docs cover, including C, C++, Ray, Pandas, Polars, and PyArrow. The Lance answer says that a Vortex file holds its own indexes, such as zone maps, and that a table format adds indexes outside the file.
How it was checked
The unit tests, the build, knip, and
bun run verifyagainst a local build pass, and each new docs link returns 200. The change is text and links only, so there are no screenshots.git commit -s), for the DCO check.bun run check:cipasses.🤖 Generated with Claude Code