Skip to content

Add docs about object evolution in editions - #9364

Open
robert3005 wants to merge 2 commits into
developfrom
rk/editions-evolution
Open

Add docs about object evolution in editions#9364
robert3005 wants to merge 2 commits into
developfrom
rk/editions-evolution

Conversation

@robert3005

Copy link
Copy Markdown
Contributor

Describe how objects can evolve in editions and what how its going to be
enforced

@robert3005
robert3005 force-pushed the rk/editions-evolution branch from efa34d4 to e49f7c2 Compare August 11, 2026 17:39
@robert3005 robert3005 added the changelog/docs A docs change label Aug 12, 2026
@robert3005
robert3005 force-pushed the rk/editions-evolution branch from e49f7c2 to bb3f3eb Compare August 13, 2026 16:21
Comment thread docs/specs/editions.md
Comment on lines +3 to +8
Vortex defines an ever-growing set of serialized formats for arrays and other durable objects.
Once a format is published, every future version of Vortex can read it. **Editions** group these
formats and record when each joined that compatibility guarantee.

An edition member is a **serialized format**: the ID written into the file, its metadata schema,
and the meaning of its buffers, children, options, or other payload. Array and layout encodings,

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.

I think we need to say that editions are a group of serde objects (array encoding, layout, ....) that are allowed to be written.

This overfits arrays.

Comment thread docs/specs/editions.md
unrecognised encodings into inert placeholders.
Vortex defines an ever-growing set of serialized formats for arrays and other durable objects.
Once a format is published, every future version of Vortex can read it. **Editions** group these
formats and record when each joined that compatibility guarantee.

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.

"hen each joined that compatibility guarantee."
should expand and talk about min required vortex (or a guess later plugin) version to read the file.

Signed-off-by: Robert Kruszewski <github@robertk.io>
Signed-off-by: Robert Kruszewski <github@robertk.io>
@robert3005
robert3005 force-pushed the rk/editions-evolution branch from bb3f3eb to 4d7d286 Compare August 13, 2026 16:37
@codspeed-hq

codspeed-hq Bot commented Aug 13, 2026

Copy link
Copy Markdown

Merging this PR will degrade performance by 2.4%

⚠️ 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

⚡ 1 improved benchmark
❌ 2 regressed benchmarks
✅ 1991 untouched benchmarks
⏩ 89 skipped benchmarks1

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Mode Benchmark BASE HEAD Efficiency
WallTime words_gather_scalar[65536] 8.3 µs 9.4 µs -12.09%
Simulation take[small_m/shuffled/primitive/nonnull/chunks=16384/indices=16] 1 ms 1.2 ms -11.32%
Simulation cold_misaligned[(64, 256)] 5.2 ms 4.4 ms +19.28%

Tip

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


Comparing rk/editions-evolution (4d7d286) with develop (c17e058)2

Open in CodSpeed

Footnotes

  1. 89 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

  2. No successful run was found on develop (1a493b6) during the generation of this report, so c17e058 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

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