Improve documentation #68
Conversation
|
Looks good!
Maybe we can avoid duplication with something like |
src/lib.rs
Outdated
| //! - Only one of these features can be enabled at a time. | ||
| //! - There is one feature for each supported communication method: `uart`, | ||
| //! `jtag-serial` and `rtt` `no-op`. | ||
| //! - Only one of these features can be enabled at a time. |
There was a problem hiding this comment.
We might want to expand on this a bit. For example, by default, uart and jtag-serial both output to the same USB port on the esp32-s3, which can be somewhat confusing not only for newcomers.
There was a problem hiding this comment.
Right, but this changes from chip to chip, devkit to devkit, any idea on how to document this. Any idea how to improve it?
TIL!
Copy-paste error 😓 Moved the documentation the README and addressed some feedback |
Co-authored-by: Dániel Buga <bugadani@gmail.com>
Co-authored-by: Dániel Buga <bugadani@gmail.com>
SergioGasquez
force-pushed
the
feat/documentation
branch
from
6edb1ed to
25c83aa
Compare
Co-authored-by: Dániel Buga <bugadani@gmail.com>
Co-authored-by: Dániel Buga <bugadani@gmail.com>
Co-authored-by: Jesse Braham <jessebraham@users.noreply.github.com>
We can probably use the same documentation in the readme, so I will wait until I get some feedback, and then I will copy it to the readme.