Skip to content

Expanding conceptual docs (and some other minor docs)#8552

Merged
AdamGS merged 5 commits into
developfrom
adamg/expands-rustdocs-from-docs
Jun 23, 2026
Merged

Expanding conceptual docs (and some other minor docs)#8552
AdamGS merged 5 commits into
developfrom
adamg/expands-rustdocs-from-docs

Conversation

@AdamGS

@AdamGS AdamGS commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds more docs, both module level conceptual docs which pulls from docs/, and many local changes documenting specific functions or types. Also tried to include basic examples.

The main changes are in vortex, vortex-array and vortex-file and vortex-layout.

Was done with the help of Claude to try and find gaps/mistakes, and fill in some of the obvious changes.

AdamGS added 4 commits June 23, 2026 11:26
Signed-off-by: Adam Gutglick <adam@spiraldb.com>
Signed-off-by: Adam Gutglick <adam@spiraldb.com>
Signed-off-by: Adam Gutglick <adam@spiraldb.com>
Signed-off-by: Adam Gutglick <adam@spiraldb.com>
@AdamGS AdamGS requested review from a team, gatesn, joseph-isaacs and robert3005 June 23, 2026 11:26
@AdamGS AdamGS added the changelog/docs A docs change label Jun 23, 2026
@codspeed-hq

codspeed-hq Bot commented Jun 23, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

⚠️ Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 5 improved benchmarks
❌ 3 regressed benchmarks
✅ 1575 untouched benchmarks

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Mode Benchmark BASE HEAD Efficiency
Simulation chunked_varbinview_into_canonical[(1000, 10)] 168.9 µs 205.6 µs -17.85%
Simulation slice_empty_vortex 310 ns 368.3 ns -15.84%
Simulation rebuild_naive 99.8 µs 111 µs -10.09%
Simulation chunked_bool_canonical_into[(1000, 10)] 27 µs 16.1 µs +67.45%
Simulation chunked_varbinview_canonical_into[(100, 100)] 258.9 µs 223.7 µs +15.71%
Simulation bitwise_not_vortex_buffer_mut[128] 244.4 ns 215.3 ns +13.55%
Simulation chunked_varbinview_into_canonical[(100, 100)] 306 µs 270.8 µs +13.01%
Simulation bitwise_not_vortex_buffer_mut[1024] 304.7 ns 275.6 ns +10.58%

Tip

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


Comparing adamg/expands-rustdocs-from-docs (6a08e69) with develop (226477d)

Open in CodSpeed

@robert3005 robert3005 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This

@AdamGS AdamGS merged commit f9ab66b into develop Jun 23, 2026
68 of 69 checks passed
@AdamGS AdamGS deleted the adamg/expands-rustdocs-from-docs branch June 23, 2026 15:28
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