ci: add "Build and test book" job and basic getting started chapter #263
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
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.
In an effort to keep the mdbook up-to-date, we need CI to be able to tell us if its code snippets don't compile with the current plugin. This adds such a job to the lint CI, and leverages mdbook-keeper to do so since we need to be able to depend on 3rd party crates in the book code.
This also adds some basic text to the getting started tutorial in the book. This text was basically copied from the README.md. This should be updated in the future to be more tutorial-y, and once it is, we should update the README.md/lib.rs to link to the book rather than have their own copy of the getting started guide. This was mostly added in this PR so that the new CI job has some code to test.