Update documentation - Githubissues

raiden-network / microraiden

MIT License

361 stars 101 forks source link

Update documentation #289

Open devium opened 6 years ago

devium commented 6 years ago

Quite a lot has changed (and will change during this sprint) concerning usage of the proxy and python client/lib. We should consolidate README-like information into a single top-level README.md file and update usage instructions on basic examples.

We should also document all classes and methods (using docstrings) that are expected to be used by applications building on top of µRaiden.

scuzzleb commented 6 years ago

when will you finish that issue?

pcppcp commented 6 years ago

We're currently working on docs update and we'd also like to have docs available on readthedocs Please check PR #345 for updates on progress

loredanacirstea commented 6 years ago

Some proposed todos:

update system overview (+diagrams) (done in https://github.com/raiden-network/microraiden/pull/385)
add in main Readme
- mention full/light node compatibility
- client can use MetaMask; Parity not supported yet
mention close all channels script in docs
mention where the state files are kept and that they should be backed up - this is where all the balance proofs exist
add gitter channel button (done)