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

Missing documentation? #258

Open
VorpalBlade opened this issue Apr 26, 2023 · 3 comments
Open

Missing documentation? #258

VorpalBlade opened this issue Apr 26, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@VorpalBlade
Copy link

There doesn't seem to be much documentation at all in this project. I'm new to embedded rust, and seeing https://esp-rs.github.io/esp-idf-svc/esp_idf_svc/index.html is disheartening.

In addition: what do the various features do? That would also be documented in an ideal world. How does alloc here differ from alloc_handler in esp-idf-sys for example?

@Vollbrecht
Copy link
Collaborator

@MihaelBercic
Copy link

Documentation still sadly fails to build...

@Vollbrecht
Copy link
Collaborator

Vollbrecht commented Apr 14, 2024

Documentation still sadly fails to build...

The issue is about lag of content of documentation not about documentation that is not build-able . Please don't hijack the issue. If you have such an issue please make a separate issue about it.

Since for bindgen generation of the C api we probably will never have working docs.rs docs. Because of that we host the docu ourself here. You are also able to build the docs with cargo docs locally

@Vollbrecht Vollbrecht added the documentation Improvements or additions to documentation label Jun 21, 2024
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
None yet
Development

No branches or pull requests

3 participants