add a doc module, and write only documentation that will appear in the crate docs
write a book with mdbook separate from Rust documentation
The last solution seems the most extensible to me, so I'm looking into it.
For example of Rust crate using mdbook, look at failure"Guide-style introduction is available here."
Wenzel
commented
3 years ago
The project only has API reference, thanks to
cargo doc.Following https://documentation.divio.com/, we should have
Cargo tooling doesn't yet provide a way to add markdown files included in the crate's documentation: https://github.com/rust-lang/cargo/issues/739
Solutions
docmodule, and write only documentation that will appear in the crate docsThe last solution seems the most extensible to me, so I'm looking into it. For example of Rust crate using mdbook, look at failure "Guide-style introduction is available here."