Skip to content

Update Kani Book#3474

Merged
carolynzech merged 5 commits into
model-checking:mainfrom
carolynzech:update-docs
Sep 4, 2024
Merged

Update Kani Book#3474
carolynzech merged 5 commits into
model-checking:mainfrom
carolynzech:update-docs

Conversation

@carolynzech

Copy link
Copy Markdown
Contributor

Add the following to the book:

  • Reference section on contracts. The point of this section is not to be an exhaustive explanation--we have good documentation on contracts already, and we don't want to maintain it in two places. The goal of the section is to give readers an intuition for the main idea and then direct them to more detailed resources.
  • Add a reference to the blog--it's a good resource to learn about Kani and it would be nice to have an easier way to find it. Inspired by this post.
  • Move the crates documentation earlier. This partly addresses #3029 by at least making our crates documentation more visible in the book. (I don't have this PR as resolving that issue, since we would need to actually publish the docs on crates.io to do that.)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

@carolynzech carolynzech marked this pull request as ready for review August 30, 2024 20:50
@carolynzech carolynzech requested a review from a team as a code owner August 30, 2024 20:50
Comment thread docs/src/getting-started.md Outdated
Comment thread docs/src/reference/experimental/contracts.md
Comment thread docs/src/reference/experimental/contracts.md Outdated
Comment thread docs/src/reference/experimental/contracts.md Outdated
Comment thread docs/src/reference/experimental/contracts.md Outdated

@zhassan-aws zhassan-aws left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@carolynzech carolynzech added this pull request to the merge queue Sep 4, 2024
Merged via the queue into model-checking:main with commit edded56 Sep 4, 2024
@carolynzech carolynzech deleted the update-docs branch September 4, 2024 02:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants