Skip to content

Docs: Updates for "Getting started" and "On a package"#1003

Merged
adpaco-aws merged 2 commits intomodel-checking:mainfrom
adpaco-aws:doc-review-intro
Apr 5, 2022
Merged

Docs: Updates for "Getting started" and "On a package"#1003
adpaco-aws merged 2 commits intomodel-checking:mainfrom
adpaco-aws:doc-review-intro

Conversation

@adpaco-aws
Copy link
Contributor

Description of changes:

Updates "Getting started" and "On a package":

  • Removes second "Getting started" section (installation is next)
  • Simplifies cargo kani introduction and removes "common arguments", as these are the same now

I've doubts about which words to use (package, project, crate, workspaces) when discussing "configurations". I've used "packages" since that seems the most generic concept. Let me know if you would like me to use something else.

Resolved issues:

Part of #700

Call-outs:

Testing:

  • How is this change tested? N/A

  • Is this a refactor change? No.

Checklist

  • Each commit message has a non-empty body, explaining why the change was made
  • Methods or procedures are documented
  • Regression or unit tests are included, or existing tests cover the modified code
  • My PR is restricted to a single feature or bugfix

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

@adpaco-aws adpaco-aws requested a review from a team as a code owner March 31, 2022 22:11
Copy link
Contributor

@jaisnan jaisnan left a comment

Choose a reason for hiding this comment

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

Thanks!

@adpaco-aws adpaco-aws merged commit c4c2c17 into model-checking:main Apr 5, 2022
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