badoo/Decompose

Describe routing options in the docs

arkivanov opened this issue · 3 comments

Docs page: https://arkivanov.github.io/Decompose/router/overview/

We should describe the Navigator.navigate {} function and all extension functions. Also describe the Router and the Navigator interfaces hierarchy.

Is there any examples using the Navigator API? I could probably help out with this

@plusmobileapps I would welcome a contribution here, thank you. The Router interface extends the Navigator interface, just for better interface segregation. So Navigator is used every time the Router.navigate(...) method is used.

We should also describe all extension functions located here.

Closed via #219. Thanks @plusmobileapps for the contribution!