light-client icon indicating copy to clipboard operation
light-client copied to clipboard
verified publisher icon raiden-network

Improve content of the SDK docs

Open christianbrb opened this issue 5 years ago • 2 comments

Description

We want to improve the content of the SDK docs.

Acceptance criteria

Tasks

  • [ ] @weilbith Please add your top 7 questions for the SDK here :)

christianbrb avatar Jun 23 '20 10:06 christianbrb

Top questions (not sorted by any property):

  1. How to run the integrations tests correctly? How do you interpret integration here? Why is there no reference to the docs/script in the SDK? NPM scripts are inconsistent.
  2. How to access data in the SDK efficiently (e.g. async/await style) like getting transfer history? (maybe refer to CLI as simple layer that does this)
  3. Due to is functional approach the API reference section in the docs is only useful for externals. Is there a graph/overview of all the reactive epics that build the heart of the SDK?
  4. What is this dependencies object for the epics about with the latest property? Why not an observable here?
  5. When and where should I use branded types for the runtime validation? Why are not all inputs validated?
  6. How does the communication with matrix work?
  7. I'm heavily missing explanatory names to wrap smaller parts of the code or variables to make code easier to understand. Most functions are quite complex and give barely any insight in what they are doing.

weilbith avatar Jun 24 '20 09:06 weilbith

@weilbith Great thanks :)

christianbrb avatar Jun 24 '20 10:06 christianbrb