Skip to content

Documentation: Application (new chapter)#984

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

Documentation: Application (new chapter)#984
adpaco-aws merged 5 commits intomodel-checking:mainfrom
adpaco-aws:review-doc-add-application

Conversation

@adpaco-aws
Copy link
Contributor

@adpaco-aws adpaco-aws commented Mar 25, 2022

Description of changes:

Adds a new "Application" chapter that includes the "tool comparison" and "where to start on real code" section. I think there is enough material there and, in the future, the section can host an article on integration or complex proof debugging.

Note that some stuff has been moved around, but other than that I only made minor changes to the already-existing articles.

Resolved issues:

Part of #700

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 25, 2022 21:15
@adpaco-aws adpaco-aws changed the title Documentation: Application (new section) Documentation: Application (new chapter) Apr 1, 2022

## Summary

In this section:
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should keep a summary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Some sections had it while others did not, so during #700 I removed all of them. I don't think they add too much at the section level, at least with the content we currently have.

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! Apologies for the late approval, I thought I had approved this already

@adpaco-aws adpaco-aws merged commit f59c348 into model-checking:main Apr 5, 2022
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 26, 2022
* Documentation: Applications (new section)

* Address Jai's comments.
tedinski pushed a commit that referenced this pull request Apr 27, 2022
* Documentation: Applications (new section)

* Address Jai's comments.
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