Skip to content

Commit f675d13

Browse files
adpaco-awszhassan-aws
authored andcommitted
Documentation: Extend "Developer documentation" (rust-lang#988)
* Documentation: Extend "Developer documentation" * Update docs/src/dev-documentation.md Co-authored-by: Zyad Hassan <[email protected]>
1 parent 3d683c1 commit f675d13

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/src/dev-documentation.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,14 @@ The easiest way to contribute is to [report any
66
issue](https://github.com/model-checking/kani/issues/new/choose) you encounter
77
while using the tool. If you want to contribute to its development,
88
we recommend looking into [these issues](https://github.com/model-checking/kani/contribute).
9+
10+
In this chapter, we provide documentation that might be helpful for Kani
11+
developers (including external contributors):
12+
1. [Useful command-line instructions for Kani/CBMC/Git](./cheat-sheets.md).
13+
2. [Development setup recommendations for working with `rustc`](./rustc-hacks.md).
14+
3. [Guide for testing in Kani](./testing.md).
15+
16+
> **NOTE:** The developer documentation is intended for Kani developers and not
17+
users. At present, the project is under heavy development and some items
18+
discussed in this documentation may stop working without notice (e.g., commands
19+
or configurations). Therefore, we recommend users to not rely on them.

0 commit comments

Comments
 (0)