Currently, our software documentation is limited; our Rust libraries are documented on crates.io but our Python libraries have no online docs, and only have documentation in the code itself. We need to greatly improve our code documentation so that people using our libraries or planning to develop our libraries don't immediately get confused.
This involves both Python and Rust-style docstrings for the web docs (user-facing docs), but also copious comments in the code, explaining every step in the code. Remember, we are trying to write software that someone completely new to Project Elara can easily pick up. There should be no "mysteries" within the code, essentially there should be a comment every 2-3 lines at most.
Currently, our software documentation is limited; our Rust libraries are documented on [crates.io](https://crates.io) but our Python libraries have no online docs, and only have documentation in the code itself. We need to greatly improve our code documentation so that people using our libraries or planning to develop our libraries don't immediately get confused.
This involves both Python and Rust-style docstrings for the web docs (user-facing docs), but also copious comments in the code, explaining every step in the code. Remember, we are trying to write software that someone completely new to Project Elara can easily pick up. There should be no "mysteries" within the code, essentially there should be a comment every 2-3 lines at most.