|
|
||
|---|---|---|
| .. | ||
| derive_ref | ||
| tutorial_builder | ||
| tutorial_derive | ||
| cargo-example-derive.md | ||
| cargo-example-derive.rs | ||
| cargo-example.md | ||
| cargo-example.rs | ||
| demo.md | ||
| demo.rs | ||
| escaped-positional-derive.md | ||
| escaped-positional-derive.rs | ||
| escaped-positional.md | ||
| escaped-positional.rs | ||
| find.md | ||
| find.rs | ||
| git-derive.md | ||
| git-derive.rs | ||
| git.md | ||
| git.rs | ||
| multicall-busybox.md | ||
| multicall-busybox.rs | ||
| multicall-hostname.md | ||
| multicall-hostname.rs | ||
| pacman.md | ||
| pacman.rs | ||
| README.md | ||
| repl.rs | ||
| typed-derive.md | ||
| typed-derive.rs | ||
Examples
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.
Contributing
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