We try to focus our documentation on the four types of documentation. Examples fit into this by providing:
- Cookbook / How-To Guides
- Tutorials (derive, builder)
This directory contains the source for the above.
New examples should fit within the above structure and support their narrative
- Add the example to Cargo.toml for any
required-features - Document how the example works with a
.mdfile which will be verified using trycmd - Pull the
.rsand.mdfile into the appropriate module doc comment to be accessible on docs.rs