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

Unstable documentation proof of concept #2628

Merged
merged 3 commits into from
Dec 2, 2024
Merged

Conversation

bugadani
Copy link
Contributor

@bugadani bugadani commented Nov 29, 2024

Closes #2498

image

@bugadani bugadani added the documentation Improvements or additions to documentation label Nov 29, 2024
@MabezDev
Copy link
Member

Looks good! How do we want to go about landing this?

We could mark all the modules we're not actively trying to stabilize in this PR, and then for the modules we are trying to stabilize we add the analysis issue link to each? Alternatively we could leave the 4 drivers we're trying to stabilize alone in this PR and follow up with the outcome from the analysis issues.

@MabezDev
Copy link
Member

I guess the third option is don't mark anything yet, but just merge this as the prior construction work

@bugadani
Copy link
Contributor Author

As this PR doesn't address #2499 I don't think I should mark anything unstable :) But:

  • for one, I want to add the matching not_actually_docsrs to esp-wifi, so that we don't lose the banner there
  • we might want to default-enable unstable for now, just to make our lives easier. We can then incrementally add the unstable gates as we see fit.

@bugadani bugadani marked this pull request as ready for review November 29, 2024 14:39
@bugadani
Copy link
Contributor Author

I guess I should at least changelog the new feature, but maybe also start writing the migration guide as well. I don't think we need anything fancy, but this will need to be mentioned.

@bugadani bugadani added the skip-changelog No changelog modification needed label Nov 29, 2024
Copy link
Member

@jessebraham jessebraham left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@playfulFence playfulFence 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!
It will take some amount of work to label all such things, but PoC is successful IMO.

@MabezDev MabezDev added this pull request to the merge queue Dec 2, 2024
Merged via the queue into esp-rs:main with commit 9f3476b Dec 2, 2024
28 of 29 checks passed
@bugadani bugadani deleted the docs branch December 2, 2024 11:10
MikeGstefan added a commit to MikeGstefan/esp-hal that referenced this pull request Jan 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow docs to show unstable features
4 participants