Project Documentation

[alensiljak]

Having an official documentation in RustDoc in the form of a book would be handy.

Having multiple redundant copies of the source should be avoided.

The Wiki here is useful as a notepad but is not portable, hence it would be better to have documentation in the source code, itself. Using RustDoc format for the code documentation, and mdBook general project documentation, which compiles into a PWA site (cached, searchable).

The docs.rs contain only the code for a published crate.

[alensiljak]

This is the tool for generating the book-like project documentation.

• https://rust-lang.github.io/mdBook/

[alensiljak]

See the Cookbook repo for a working sample.
Or https://ledger-rs.github.io/cookbook/

[alensiljak]

The main documentation in terms of features and the syntax should still remain Ledger's documentation. For now, this is a rewrite and a compatible implementation (will have less features for a while).
Any potential new features must remain compatible with the existing syntax (this is still hypothetical, however).
So far I see no need for specific documentation other than

• readme,
• contributing,
• syntax diagram,
• project web site (at https://ledger-rs.github.io)