Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
When we restuctured the examples, we lost the notes on how they should be structured, so this adds it back in.
- Loading branch information
Showing
2 changed files
with
16 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Examples | ||
|
||
We try to focus our documentation on the [four types of | ||
documentation](https://documentation.divio.com/). Examples fit into this by | ||
providing: | ||
- [Cookbook / How-To Guides](https://docs.rs/clap/latest/clap/_cookbook/index.html) | ||
- Tutorials ([derive](https://docs.rs/clap/latest/clap/_derive/_tutorial/index.html), [builder](https://docs.rs/clap/latest/clap/_tutorial/index.html) | ||
|
||
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.tom](../Cargo.toml) for any `required-features` | ||
- Document how the example works with a `.md` file which will be verified using [trycmd](https://docs.rs/trycmd) | ||
- Pull the `.rs` and `.md` file into the appropriate module doc comment to be accessible on docs.rs |