Description
Code examples on the documentation website (https://leakix.github.io/oxide-sql/) should be:
- Stored in rustdoc comments in the source code
- Compiled during doc generation to ensure they're always valid
- Referenced from the website, not duplicated
Current State
- Code examples are duplicated in markdown files
- Examples may become stale if API changes
Desired State
- Code lives in rustdoc comments with
/// or //!
- Examples use
# to hide boilerplate
- CI compiles all doc examples (
cargo test --doc)
- Website pages link to rustdoc for examples
References
- Similar to how o1-labs/mina-rust handles documentation
- Docusaurus can redirect to docs.rs pages
Tasks
Description
Code examples on the documentation website (https://leakix.github.io/oxide-sql/) should be:
Current State
Desired State
///or//!#to hide boilerplatecargo test --doc)References
Tasks
doc/docs/schema/queries.mdto rustdoccargo test --doc