search

esp-rs / esp-idf-svc

Type-Safe Rust Wrappers for various ESP-IDF services (WiFi, Network, Httpd, Logging, etc.)
https://docs.esp-rs.org/esp-idf-svc/
Apache License 2.0
303 stars 172 forks source link

Missing documentation? #258

Open VorpalBlade opened 1 year ago

VorpalBlade commented 1 year ago

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 commented 1 year ago

Related to: https://github.com/esp-rs/esp-idf-sys/issues/194 https://github.com/esp-rs/esp-idf-hal/issues/242

MihaelBercic commented 5 months ago

Documentation still sadly fails to build...

Vollbrecht commented 5 months ago

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