Guide with mdbook #975
Merged
Guide with mdbook #975
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
- Various placeholder sections - Section on final reborrows - Section on requires/ensures - Section on snapshots
This also removes the `guide-ci.yml` workflow, since the example we want to test need Creusot instead of normal Rust.
Thanks for starting the work! I think we can merge this PR but here are two ideas for the future of README:
|
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.
This moves the user documentation out of the README (which was starting to be a bit busy IMO) an into the already existing mdbook.
I also filled some sections, but a lot more remains to be done.
It would also be cool if we could check that the examples are indeed provable (or even compilable) in CI.