Skip to content

Minor documentation improvements #460

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.

Sign up for GitHub

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

Jump to bottom
Merged
jessebraham merged 3 commits into from
Mar 30, 2023
Merged

Minor documentation improvements #460

jessebraham merged 3 commits into from
Mar 30, 2023

Conversation

@jessebraham
Copy link
Member

@jessebraham jessebraham commented Mar 29, 2023

Nothing major, but some small incremental improvements towards #29:

  • Update all packages to use the esp-rs logo in their documentation
  • Add appropriate metadata features to ensure all relevant items are present in documentation
  • Add README.md to esp-hal-procmacros package
  • Small tweaks and improvements to docstrings in esp-hal-procmacros and esp-hal-smartled

@jessebraham jessebraham requested review from MabezDev and bjoernQ March 29, 2023 18:57
JurajSadel
JurajSadel approved these changes Mar 30, 2023
View reviewed changes
Copy link
Contributor

@JurajSadel JurajSadel left a comment

Choose a reason for hiding this comment

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

LGTM!

bjoernQ
bjoernQ approved these changes Mar 30, 2023
View reviewed changes
Copy link
Contributor

@bjoernQ bjoernQ left a comment

Choose a reason for hiding this comment

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

LGTM

@jessebraham jessebraham merged commit a910402 into esp-rs:main Mar 30, 2023
@jessebraham jessebraham deleted the feature/docs branch March 30, 2023 13:06
i404788 pushed a commit to i404788/esp-hal that referenced this pull request Jul 22, 2023
@jessebraham @i404788
Minor documentation improvements (esp-rs#460)
a36c54a 
* Add README, improve documentation for `esp-hal-procmacros`

* Improve documentation for `esp-hal-smartled`

* Use esp-rs logo for all packages' documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bjoernQ bjoernQ bjoernQ approved these changes

@JurajSadel JurajSadel JurajSadel approved these changes

@MabezDev MabezDev Awaiting requested review from MabezDev

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jessebraham @bjoernQ @JurajSadel