microraiden icon indicating copy to clipboard operation
microraiden copied to clipboard

Published 20 hours ago • verified publisher icon raiden-network

Update documentation

Open devium opened this issue 7 years ago • 3 comments

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.

devium avatar Dec 14 '17 09:12 devium

when will you finish that issue?

scuzzleb avatar Jan 11 '18 10:01 scuzzleb

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

pcppcp avatar Jan 11 '18 10:01 pcppcp

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)

loredanacirstea avatar Jan 15 '18 13:01 loredanacirstea