Skip to content

Better READMEs and user docs - #10960

Merged
myrrc merged 8 commits into
developfrom
myrrc/user-guide-docs
Nov 2, 2026
Merged

myrrc merged 8 commits into
developfrom
myrrc/user-guide-docs

Conversation

@myrrc

@myrrc myrrc commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor
  • Remove "Future work" sections from docs
  • Move docs on how to integrate DataFusion as a crate into "Developer docs"
  • Make language bindings docs smaller, update C++ API implementation.
  • Add more SQL examples on Duckdb user guide page.
  • Make vortex-ffi and vortex-sqllogictest READMEs less verbose.

@codspeed

codspeed Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Merging this PR will degrade performance by 26.33%

1 warning

⚠️ Walltime results may be unreliable

Some benchmarks used the Walltime instrument outside CodSpeed Macro Runners, which can make the results inconsistent.

Learn more about Macro Runners

See affected benchmarks

❌ 4 regressed benchmarks
✅ 2314 untouched benchmarks

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Mode Benchmark BASE HEAD Efficiency
❌ Walltime filter_neon[64] 1.9 µs 2.8 µs -33.38%
❌ Walltime threshold_neon[64] 2.6 µs 3.8 µs -31.96%
❌ Walltime filter_neon[80] 2.6 µs 3.4 µs -21.91%
❌ Walltime threshold_neon[80] 3.4 µs 4.1 µs -16.81%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.


Comparing myrrc/user-guide-docs (c686a1e) with develop (9085458)

Open in CodSpeed

@myrrc
myrrc force-pushed the myrrc/user-guide-docs branch from 113e303 to 541cabf Compare October 30, 2026 12:13
@myrrc
myrrc force-pushed the myrrc/user-guide-docs branch from 200a6c0 to c686a1e Compare November 2, 2026 10:35
@myrrc
myrrc marked this pull request as ready for review November 2, 2026 10:35
@myrrc myrrc added the changelog/docs A docs change label Nov 2, 2026
@myrrc
myrrc merged commit 085c871 into develop Nov 2, 2026
152 of 154 checks passed
@myrrc
myrrc deleted the myrrc/user-guide-docs branch November 2, 2026 10:43

This branch was successfully deployed

1 active deployment
vercel-docs — c686a1ed Deployed Nov 2, 2026 by myrrc via Publish preview / Deploy #7209
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/docs A docs change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants