Updates for front-page documentation #1138
Merged
Conversation
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
zhassan-aws
reviewed
Apr 29, 2022
docs/src/getting-started.md
Outdated
| is generally up-to-date with the latest Rust language features. | ||
| Kani usually synchronizes with the nightly release of Rust every two weeks, and so is generally up-to-date with the latest Rust language features. | ||
|
|
||
| If you encounter issues when using Kani we encourage you to report them to us (https://github.com/model-checking/kani/issues/new/choose). |
There was a problem hiding this comment.
Suggested change
| If you encounter issues when using Kani we encourage you to report them to us (https://github.com/model-checking/kani/issues/new/choose). | |
| If you encounter issues when using Kani, we encourage you to report them to us (https://github.com/model-checking/kani/issues/new/choose). |
There was a problem hiding this comment.
Thanks for this suggestion, made me realize that the link in this sentence was not being associated with "report them to us"!
| @@ -1,9 +1,9 @@ | |||
| # Working with `rustc` | |||
| Kani is developed on the top of the rust compiler, which is not distributed on crates.io and it depends on | |||
| Kani is developed on the top of the rust compiler, which is not distributed on [crates.io](https://crates.io/) and it depends on | |||
| bootstrapping mechanisms to properly build its components. | |||
There was a problem hiding this comment.
Is the "bootstrapping mechanisms" part still relevant?
There was a problem hiding this comment.
I think it is explaining why this dependency does not appear in Cargo.toml: The Rust compiler depends on them to properly build, so code extensions need an extra setting for this. I removed the "it" from "it depends on" so that it's clear we're talking about the compiler and not Kani.
tedinski
approved these changes
May 2, 2022
4 tasks
celinval
added a commit
that referenced
this pull request
Jun 28, 2023
Fix broken link introduced by #1138 and add a link to Coding conventions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
Mainly updates for the README and "Getting started" section to be more specific about what Kani does. Note that this is almost the same as #1055 , but includes suggestions from that code review and some minor fixes.
Testing:
How is this change tested? N/A
Is this a refactor change? No.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.