Update time travel docs

arkivanov / MVIKotlin

Extendable MVI framework for Kotlin Multiplatform with powerful debugging tools (logging and time travel)

https://arkivanov.github.io/MVIKotlin

Apache License 2.0

847 stars 32 forks source link

Update time travel docs #54

Closed arkivanov closed 1 year ago

arkivanov commented 2 years ago

The plugin functionality is actually similar to the desktop client app, it can connect to Android, JVM and Darwin apps. Also there are typos, e.g. "All recording events will appear ...". Link: https://arkivanov.github.io/MVIKotlin/time_travel.html

Gilbert1817 commented 2 years ago

Pls help,and guide me to fill-up for the guidelines.

arkivanov commented 2 years ago

The source file is here: https://github.com/arkivanov/MVIKotlin/blob/master/docs/time_travel.md

There are the following mistakes:

The section Using time travel clients mentions only Android for the IntelliJ IDEA plugin, however it should be same as for the standalone desktop client. So both sections should be updated to nicely reflect the thing.
There is a typo in the doc page - "All recording events will appear ...", I guess it should be "All recorded events will appear ...".