Improve the top level crate documentation #1467
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
MabezDev
force-pushed
the
top-level-docs
branch
2 times, most recently
from
a2f1b7b to
81e7039
Compare
MabezDev
commented
Apr 17, 2024
esp-hal/src/lib.rs
Outdated
| //! cargo xtask help | ||
| //! ``` | ||
| //! | ||
| //! ## Project generation |
There was a problem hiding this comment.
I imagine when $GLUE_CRATE exists, this documentation will move there. I'm not raving about it being here, but I think for now its worth adding, and its short enough to not be too invasive imo
bjoernQ
reviewed
Apr 18, 2024
bjoernQ
reviewed
Apr 18, 2024
MabezDev
force-pushed
the
top-level-docs
branch
from
81e7039 to
ffd6a74
Compare
JurajSadel
reviewed
Apr 18, 2024
MabezDev
force-pushed
the
top-level-docs
branch
2 times, most recently
from
e1feaff to
30e2913
Compare
MabezDev
force-pushed
the
top-level-docs
branch
from
30e2913 to
c6a5550
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.
Thank you for your contribution!
We appreciate the time and effort you've put into this pull request.
To help us review it efficiently, please ensure you've gone through the following checklist:
Submission Checklist 📝
CHANGELOG.mdin the proper section.Extra:
I wanted to expand a little on our top level docs as to what the hal is and how to use it. I have tried to keep it as brief as possible. I also lifted the docsrs style as outlined in https://docs.rs/document-features/latest/document_features/#customization and I think it helps differentiate the readable content from the "features" content
Check out the rendered pages here: https://mabezdev.github.io/esp-hal/