Development

This page is for contributors working on Delta Arrow Reader itself. Applications that use the crate can start with the installation guide.

Run the local checks

The repository CI tests every supported feature combination. Run these focused checks before opening a pull request:

cargo fmt --all -- --check
cargo clippy --locked --all-targets --all-features -- -D warnings
cargo test --locked --all-features
RUSTDOCFLAGS="-D warnings" cargo doc --locked --all-features --no-deps
cargo package --locked

Work on the documentation

The Markdown files in docs/content/ are the source for the documentation site. The guides listed in src/guides.rs are also included in the generated Rust documentation.

Use absolute links between shared pages. Mark runnable Rust examples as no_run, and mark incomplete snippets as ignore, so both documentation renderers handle them correctly.

Install the documentation dependencies, then build or serve the site:

python -m pip install -r docs/requirements.txt
python -m zensical build --strict -f docs/mkdocs.yml
python -m zensical serve -f docs/mkdocs.yml