Local Development

If you want to work on ado-aw itself, a local Rust-based development setup is enough for most compiler and documentation tasks.

Prerequisites

• Rust 1.94.0 or later (the project uses the Rust 2024 edition)
• Git
• An editor of your choice

Install or update Rust:

rustup toolchain install stable
rustup default stable
rustc --version  # must be 1.94.0 or later

Build from source

From the repository root:

cargo build

For an optimized build:

cargo build --release

Run the test suite

Use the standard Rust workflow while developing:

cargo test
cargo clippy

These commands help catch regressions and style issues before you commit changes.

Test compilation locally

A simple way to validate changes is to compile an example or your own agent file.

cargo run -- compile path/to/agent.md

To verify the generated YAML matches the source definition:

cargo run -- check path/to/agent.lock.yml

Iterate on documentation or compiler changes

A common local loop looks like this:

cargo build
cargo test
cargo run -- compile path/to/agent.md
cargo run -- check path/to/agent.lock.yml

If you are working on the docs site itself, run the site from site/ with your usual Astro workflow after installing dependencies.

What to verify before submitting changes

• the project builds successfully
• tests pass
• your sample pipeline compiles cleanly
• generated YAML matches the markdown source when checked