Repository navigation
Commit fc3c0c9
authored
Link each FAQ answer to the docs page that covers it (#219)
* Add an FAQ page, with FAQPage structured data
/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>
* Rewrite the FAQ in the company voice
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>
* Base the FAQ's speed claim on bench's verdicts, and name integrations 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>
* Scale the FAQ's yes to bench's wins, and leave an unmeasured size open
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>
* Compare Vortex with Lance in the FAQ, and add TPC-H SF10 to both comparisons
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>
* Say what Iceberg's proposal would do in the FAQ's Lance answer
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>
* State who holds Vortex's and Lance's names in the FAQ
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>
* Name where Vortex's maintainers work, and link the donation announcements
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>
* Drop the gloss on CWI in the FAQ
Signed-off-by: Will Manning <will@willmanning.io>
* Correct the FAQ's file compatibility answer to match the docs
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>
* Bring the docs' facts and pages into the FAQ
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>
* Say that a Vortex file holds its own indexes, in the Lance answer
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>
---------
Signed-off-by: Will Manning <will@willmanning.io>1 parent 2606bcb commit fc3c0c9
1 file changed
Lines changed: 25 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
152 | 152 | | |
153 | 153 | | |
154 | 154 | | |
155 | | - | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
156 | 160 | | |
157 | 161 | | |
158 | 162 | | |
| |||
211 | 215 | | |
212 | 216 | | |
213 | 217 | | |
214 | | - | |
| 218 | + | |
215 | 219 | | |
216 | 220 | | |
217 | 221 | | |
| |||
246 | 250 | | |
247 | 251 | | |
248 | 252 | | |
249 | | - | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
250 | 260 | | |
251 | 261 | | |
252 | 262 | | |
| |||
270 | 280 | | |
271 | 281 | | |
272 | 282 | | |
273 | | - | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
274 | 293 | | |
275 | 294 | | |
276 | 295 | | |
| |||
316 | 335 | | |
317 | 336 | | |
318 | 337 | | |
319 | | - | |
| 338 | + | |
| 339 | + | |
320 | 340 | | |
321 | 341 | | |
322 | 342 | | |
| |||
0 commit comments