Light-client: Updating the SDK documentation from a developer perspective using the SDK

Created on 21 Aug 2019  路  7Comments  路  Source: raiden-network/light-client

Description

The payments endpoint is missing in the SDK documentation.

It needs to be checked if the SDK documentation is up to date from a developer perspective

Acceptance criteria

  • SDK documentation is up to date with the codebase
  • The Readme is updated
  • What do I need to do with the SDK to send a payment?
  • Kelsos would be happy
  • Scenarios are defined

User

  • I don't know Raiden at all
  • I just know Ethereum

Tasks

  • [ ]

Story Points

docs 馃摉 Split 鉁傦笍

Most helpful comment

npm package is working and can be used on es5, esNext & TS projects as far as I could test.

All 7 comments

Partly done in #288, still needs to improve, so should stay open

This needs to wait until we have a working package of raiden-ts on npm. It will be difficult to work on this if there is no way to try out the examples in the docs to start with.

Hopefully this can be tackled starting the next iteration.

Refinement whiteboard picture

grafik

@taleldayekh Could you break this down into actionable issues?

npm package is working and can be used on es5, esNext & TS projects as far as I could test.

Splitting in 2 or 3 issues

I wrote down some suggestions for restructuring/improving the docs in issue #709 which could be used when splitting into new issues.

Dedicated docs issues have been created and some have been already implemented:
https://github.com/raiden-network/light-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22docs+%F0%9F%93%96%22

Was this page helpful?
0 / 5 - 0 ratings

Related issues

christianbrb picture christianbrb  路  6Comments

christianbrb picture christianbrb  路  6Comments

christianbrb picture christianbrb  路  5Comments

christianbrb picture christianbrb  路  3Comments

christianbrb picture christianbrb  路  3Comments