• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Examples
2
3We try to focus our documentation on the [four types of
4documentation](https://documentation.divio.com/).  Examples fit into this by
5providing:
6- [Cookbook / How-To Guides](https://docs.rs/clap/latest/clap/_cookbook/index.html)
7- Tutorials ([derive](https://docs.rs/clap/latest/clap/_derive/_tutorial/index.html), [builder](https://docs.rs/clap/latest/clap/_tutorial/index.html))
8
9This directory contains the source for the above.
10
11## Contributing
12
13New examples should fit within the above structure and support their narrative
14- Add the example to [Cargo.toml](../Cargo.toml) for any `required-features`
15- Document how the example works with a `.md` file which will be verified using [trycmd](https://docs.rs/trycmd)
16- Pull the `.rs` and `.md` file into the appropriate module doc comment to be accessible on docs.rs
17