AI Documentation for Rust Projects
Hosted docs for Rust repos. Auto-generated, auto-updated nightly. Detects Cargo.toml, crate features, and workspaces.
Free for public repos. No account needed.
What ReadmeBot detects in your project
ReadmeBot analyses your repository and automatically identifies key configuration files and project structure. Here are the files and patterns it looks for:
Cargo.tomlCargo.locksrc/main.rs or src/lib.rsbuild.rs
What's included in your documentation
Based on what ReadmeBot finds in your repository, it generates structured documentation with the following sections tailored to your stack:
Installation via cargo
Building from source
Usage examples
Crate features
Testing with cargo test
Frequently asked questions
Does it document cargo features?
Yes. ReadmeBot parses your Cargo.toml features table and documents each feature flag with its purpose and how to enable it.
Will it detect the Rust edition?
ReadmeBot reads the edition field from Cargo.toml and includes the minimum supported Rust version in prerequisites.
Can it handle workspace projects?
Yes. ReadmeBot understands Cargo workspaces and documents the relationship between crates in multi-package repositories.