feat(xtask): auto-generate the edition registry docs from the Rust declarations#8878
Draft
joseph-isaacs wants to merge 1 commit into
Draft
feat(xtask): auto-generate the edition registry docs from the Rust declarations#8878joseph-isaacs wants to merge 1 commit into
joseph-isaacs wants to merge 1 commit into
Conversation
joseph-isaacs
force-pushed
the
claude/auto-gen-editions-docs-r9otqn
branch
from
July 21, 2026 13:20
286037c to
b9741e0
Compare
joseph-isaacs
force-pushed
the
claude/auto-gen-editions-docs-r9otqn
branch
from
July 21, 2026 13:51
b9741e0 to
ef8bb5f
Compare
Contributor
Polar Signals Profiling ResultsLatest Run
Previous Runs (1)
Powered by Polar Signals Cloud |
Contributor
Benchmarks: Vortex queries 📖Verdict: Likely regression (medium confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (1.240x ❌, 0↑ 2↓)
datafusion / parquet (1.144x ❌, 0↑ 2↓)
duckdb / vortex-file-compressed (1.222x ❌, 0↑ 2↓)
duckdb / parquet (1.070x ➖, 0↑ 0↓)
No file size changes detected. |
…clarations Generate the edition registry pages from the edition declarations in `vortex/src/editions/`, in two stages: 1. A new `editions_manifest` example in the `vortex` crate validates the declarations and dumps them (with each edition's computed full encoding set) as a TOML manifest under `target/` — a build artifact, never committed. 2. A new `cargo xtask generate-editions-docs` subcommand runs the example, parses the manifest, and rewrites `docs/specs/editions/` wholesale: `index.md` with an editions table and a per-encoding index, plus one page per edition with its status, minimum Vortex reader, the encodings it adds, and its full encoding set. The static pages link into the registry: `docs/specs/editions.md` from its "Edition registry" section (previously a "Coming soon.." placeholder) and the unknown-encoding troubleshooting flow, and the docs landing page from a short static "Editions" section. The generated-files CI job now also runs `generate-editions-docs` before its "no files changed after regenerating" check, so a declaration change without a regen fails CI, including added or removed registry pages. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XKRaAHmFNvb7JoKTJVW8Pw Signed-off-by: Claude <noreply@anthropic.com>
joseph-isaacs
force-pushed
the
claude/auto-gen-editions-docs-r9otqn
branch
from
July 21, 2026 14:00
ef8bb5f to
c4cbb90
Compare
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
2 participants
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.
Rationale for this change
Include editions in the vortex docs/
Follows #8871 (now merged), which introduced the edition declarations this generator reads.
What changes are included in this PR?
Add a manifest generator from rust (toml).
Uses the manifest to generate static docs.