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

Update docs url #291

Merged
merged 1 commit into from
Mar 8, 2024
Merged

Update docs url #291

merged 1 commit into from
Mar 8, 2024

Conversation

MabezDev
Copy link
Member

@MabezDev MabezDev commented Mar 8, 2024

No description provided.

@Vollbrecht
Copy link
Collaborator

Vollbrecht commented Mar 8, 2024

@MabezDev this is still hosted by github, just with its own domain right?
I wonder if we can expand the generated docs for each different target, e.g instead of https://docs.esp-rs.org/esp-idf-sys/ have https://docs.esp-rs.org/esp32c3/esp-idf-sys/ - https://docs.esp-rs.org/esp32c6/esp-idf-sys/ and so forth. The reason for such a format would be that we would not need to inject or change anything to the build output itself(e.g no extra html or js), so no extra burden, but we would still get the benefit of correctly generated docs for each target.

Regardless do we need to change anything with respect to our publishing procedure in our CI?

@MabezDev
Copy link
Member Author

MabezDev commented Mar 8, 2024

Yes, it's just a wrapper around github docs. Nothing needs doing for this to work (you can go to the URL right now and see).

For multichip docs, you can see: https://docs.esp-rs.org/esp-hal/ we just made a simple index that links to each chips docs - feel free to copy and paste that and change what you need :).

@ivmarkov ivmarkov merged commit 3b9fb74 into master Mar 8, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants