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

Display a warning banner linking to docs.esp-rs.org when documentation is hosted on docs.rs #1266

Merged
merged 2 commits into from
Mar 12, 2024

Conversation

jessebraham
Copy link
Member

Since there is no great solution for handling our documentation, we were forced to self-host it. However, this is a problem from a discoverability standpoint, as users who are not aware of this may check docs.rs instead.

This PR does a few things:

  • Adds the required package metadata to get the HAL building on docs.rs (targeting the ESP32-C6)
  • Adds a warning banner, only when hosted on docs.rs, which links the user to the proper documentation
  • Fixes some unrelated warnings which popped up while building the docs

@jessebraham jessebraham added the skip-changelog No changelog modification needed label Mar 12, 2024
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! Thank you!

Copy link
Member

@MabezDev MabezDev left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@jessebraham jessebraham added this pull request to the merge queue Mar 12, 2024
Merged via the queue into esp-rs:main with commit d3a5dcc Mar 12, 2024
18 of 19 checks passed
@jessebraham jessebraham deleted the fixes/docs-rs branch March 12, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants