docs: improve the hello world tutorial #107
Merged
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
|
joshka
force-pushed
the
improve-hello-world
branch
from
dc9d96a to
0a737f0
Compare
|
|
|
|
joshka
force-pushed
the
improve-hello-world
branch
2 times, most recently
from
55c6e17 to
f453af3
Compare
|
I love it! Thanks for the making the hello world tutorial so much nicer. I think this will be a improvement for those new to rust and ratatui. |
kdheepak
reviewed
Oct 10, 2023
kdheepak
reviewed
Oct 10, 2023
kdheepak
reviewed
Oct 10, 2023
code/hello-world-tutorial/Cargo.toml
Outdated
There was a problem hiding this comment.
I like the idea of having all the code in a top level folder. This is not what is currently done in the rest of the book. I think we should move all the code to the way you've structured it in this PR. Probably a good first issue.
There was a problem hiding this comment.
I think ideally we'd have a workspace at the root. That way we can build all sources with cargo build. I didn't want to shift things too much in this PR though.
kdheepak
approved these changes
Oct 10, 2023
|
Feel free to merge when you think it is ready! |
- Remove the excess side quests and information in the tutorial (e.g. rustup, LICENSE / README, release compilation, backend choice, specific ratatui versions). - add imports and 4 character indents so that the code is more idiomatic - add simple explanations about the sections of the code - fix heading size (h2 not h3) - add a `code` folder to contain tutorial code which is imported rather than included in the tutorial itself - update images to match the new code TODO: - fix windows reset command
joshka
force-pushed
the
improve-hello-world
branch
from
f453af3 to
87456d7
Compare
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.
rustup, LICENSE / README, release compilation, backend choice,
specific ratatui versions).
codefolder to contain tutorial code which is imported ratherthan included in the tutorial itself
TODO: