Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite the Introduction chapter #61

Merged
merged 3 commits into from
Jan 18, 2023

Conversation

jessebraham
Copy link
Member

@jessebraham jessebraham commented Jan 13, 2023

Leaving this as a draft because I haven't answered the "Why Should I use Rust on ESP?" question yet, and because I would like to get some feedback on the work that I have done.

This is heavily inspired by The Embedded Rust Book.

Also got rid of some pages that we decided aren't required. The content will be covered elsewhere in the future.

Rendered view: https://github.com/jessebraham/book/blob/59c3b9470bc9791e1fabe031e2d4f493ad508eeb/src/introduction.md

@SergioGasquez @MabezDev @bjoernQ @JurajSadel @georgik if any of you have any input on this I would love to hear it! Are we missing anything? Anything we could explain better?

@bjoernQ
Copy link
Contributor

bjoernQ commented Jan 16, 2023

Looks good to me, already!

Not sure if we really need to answer "Why Should I use Rust on ESP?" here, since the user who got here is probably already interested in doing that?

@SergioGasquez
Copy link
Member

Not sure if we really need to answer "Why Should I use Rust on ESP?" here, since the user who got here is probably already interested in doing that?

I think it would be beneficial to have some kind of "what advantages does this approach have?" section, maybe with a pointer to https://www.rust-lang.org/what/embedded and a few details should be sufficient

Copy link
Member

@SergioGasquez SergioGasquez left a comment

Choose a reason for hiding this comment

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

Commented on small details, they are more questions being raised than comments. Feel free to address them! Also, maybe we should include a link to our matrix channel and Awesome ESP Rust repo (?)

src/introduction.md Outdated Show resolved Hide resolved
src/introduction.md Show resolved Hide resolved
@jessebraham
Copy link
Member Author

Gonna just merge this for now, if we decide to go through with adding a section about the benefits then that can be handled in a separate PR.

@jessebraham jessebraham marked this pull request as ready for review January 18, 2023 17:45
@jessebraham jessebraham merged commit ffe4eec into esp-rs:overhaul Jan 18, 2023
SergioGasquez pushed a commit to SergioGasquez/book that referenced this pull request Apr 27, 2023
* Remove the "Resources" and "Glossary" pages

* Rewrite most of the introduction chapter

* Address review comments
jessebraham added a commit that referenced this pull request May 2, 2023
* Remove the "Resources" and "Glossary" pages

* Rewrite most of the introduction chapter

* Address review 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.

3 participants