CLI Book – Rolling Review – DO NOT MERGE #58
Closed
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
Ive already added the GITHUB_TOKEN
Just to draft out a possible book structure
mdbook setup and draft of tutorial
Renders nicely on github
These are rendered as separate pages so it makes sense to have an h1 on each one of them.
More book content
Not meant to replace the book chapter, just wants to provide an alternative perspective on this in the context of CLI apps.
Tutorial: Draft of Output chapter
Use code blocks instead of indented normal text; before, backticks were not displayed correctly.
Add missing "the"; use "it would" instead of contraction "it'd".
Drop unnecessary comments in shell sessions
Fix typo and style
Add URL to the git repository for the book
Remove superfluous empty line and fix typo
Misc. link additions.
* Add intro text to in-depth section * Bump mdbook version to 0.3.5 * Update dependencies Just to make sure they still work. Also adds actual commit hash to git dependency.
Links from doc.rust-lang.org/1.31.0 changed to 1.39.0.
Linked content largely unchanged, so nothing further needed.
One link also had a chapter title change ("Packages, Crates, and
Modules" is now "Managing Growing Projects with Packages, Crates, and
Modules"), so name of the link changed with it.
Fixes #156
As of version 0.11.0, the assert_cmd crate has dropped the
`main_binary()` function in favor of `cargo_bin()` that takes the name
of the cargo binary. Update the testing chapter of the book to use
`cargo_bin("grrs")` with the binary name hard coded. Another option
would be to use `cargo_bin(env!("CARGO_PKG_NAME"))` if you briefly
wanted to explain cargo's environmental variables and the `env!()` macro.
Make it clear source is edited in src/main.rs and where source parts are positioned. Help newbies by claryfying this.
The official discord is a ghost town, almost everything is on zulip now. Fixes #163
|
@epage Shall we close this? |
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 pull request is not meant to ever be merged.
The book is written like this: New chapters will be added in PRs, where they get a bit of review, and finally get merged into master. Once they land in master, it's hard to leave review comments, though!
This PR is meant to give you a way to review the book and leave comments in an easy way. It shows the diff between master before I added the book and master right now, so it'll always show the full book, and also automatically mark comments as resolved once new content lands in master.