Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

In-depth review of general documentation #700

Closed
adpaco-aws opened this issue Dec 15, 2021 · 1 comment · Fixed by #1016
Closed

In-depth review of general documentation #700

adpaco-aws opened this issue Dec 15, 2021 · 1 comment · Fixed by #1016
Assignees
Milestone

Comments

@adpaco-aws
Copy link
Contributor

adpaco-aws commented Dec 15, 2021

Including the following:

  • README.md file
  • Source code documentation.
  • Kani docs
@adpaco-aws adpaco-aws added this to the RMC MLP milestone Dec 15, 2021
@adpaco-aws adpaco-aws self-assigned this Dec 15, 2021
@adpaco-aws
Copy link
Contributor Author

adpaco-aws commented Mar 14, 2022

For source code documentation, we would need to make clear what the scope according to the current layout:

  • Code under src (kani-compiler, cargo-kani and cargo-metadata).
  • cprover_bindings
  • Kani docs (i.e., files under docs/src)
  • Kani libraries (i.e., files under kani/library: The kani library, kani-macros and std overrides)
  • Scripts
  • Tests
  • Tools (compiletest and bookrunner)

Note: We agreed on a team discussion that source code documentation is out of scope for this issue.

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 a pull request may close this issue.

1 participant