Description
Website code examples should be imported from actual source files that are compiled, similar to how o1-labs/mina-rust handles documentation.
Current State
Code examples in doc/docs/*.md are inline and may become stale.
Desired State
- Create example files in a
doc/examples/ directory
- Examples are compiled as part of CI
- Docusaurus imports from these files
Implementation Options
- Use Docusaurus code import feature:
@include "../../examples/basic.rs"
- Use rustdoc and link to it
- Use a build script to inject code
References
- o1-labs/mina-rust documentation approach
Description
Website code examples should be imported from actual source files that are compiled, similar to how o1-labs/mina-rust handles documentation.
Current State
Code examples in
doc/docs/*.mdare inline and may become stale.Desired State
doc/examples/directoryImplementation Options
@include "../../examples/basic.rs"References