-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels