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

Allow building different tagged docs #2142

Closed
MabezDev opened this issue Sep 11, 2024 · 2 comments
Closed

Allow building different tagged docs #2142

MabezDev opened this issue Sep 11, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@MabezDev
Copy link
Member

Right now it's only possible to build docs from a single git revision. This is a problem when we release different crates at different times, case in point the latest esp-wifi release came a few days after the esp-hal one.

We're now in a situation where the docs are outdated for esp-wifi, but if we re-run the workflow, we'll now include breaking changes for esp-hal on the docs for the last release.

We probably need to extend the workflow to collate the different versions from different tags publish them. This means we need to start tagging other projects we want to document, at the moment this is just esp-wifi.

@MabezDev MabezDev added the documentation Improvements or additions to documentation label Sep 11, 2024
@jessebraham jessebraham self-assigned this Sep 13, 2024
@MabezDev MabezDev added this to the 0.21.0 milestone Sep 16, 2024
@MabezDev MabezDev assigned MabezDev and unassigned jessebraham Sep 23, 2024
@bjoernQ
Copy link
Contributor

bjoernQ commented Sep 26, 2024

@MabezDev This can be closed? (Done in #2218 - or is there anything missing?)

@MabezDev
Copy link
Member Author

Oops! Thanks!

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
Projects
Status: Done
Development

No branches or pull requests

3 participants