Set up API documentation from source code

gaucho-labs / leptos-hotkeys

a declarative way of using keyboard shortcuts + callbacks in leptos applications

https://leptos-hotkeys.vercel.app

MIT License

43 stars 8 forks source link

Set up API documentation from source code #82

Open mondeja opened 5 months ago

mondeja commented 5 months ago

Currently the API is documented in the README but is not complete. This is not maintainable because is not generated from source code.

Instead, we should document it using docstrings in functions and arguments and provide a nice introduction in https://docs.rs/leptos_hotkeys/0.2.0-alpha.1 taken from part of the README using cargo-readme or something like that. Rust developers are more accustomed to reading the documentation on docs.rs.

mondeja commented 5 months ago

Seems to me that this is not worth to accomplish for v0.2.0 because the API will change a bit on v0.3.0, so I'm posponing it...