Skip to content

Add terrakok/FlowMarbles as stories to the Flow documentation #4484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JSMonk
Copy link
Member

@JSMonk JSMonk commented Jul 20, 2025

The MR is attaching a fantastical interactive explanation (created by @terrakok) of how Flow operations work to their documentation.

The result of the MR is presented in the attached video:

Screen.Recording.2025-07-20.at.6.24.17.PM.mov

@JSMonk JSMonk requested a review from fzhinkin July 20, 2025 16:35
@fzhinkin
Copy link
Contributor

@JSMonk, @terrakok nicely done!

There are two aspects here:

  1. Correctness of visualizations: it's up to @murfel or @dkhalanskyjb to decide if something has to be changed.
  2. Visualizations are currently reside in a separate repository and if we're going to include them into official docs, they should be hosted alongside all other documentation. Are there any specific requirements for that?

@@ -26,6 +26,8 @@ fun main() = runBlocking {
*/

/**
* @story https://jsmonk.github.io/FlowMarbles/?embedded=true#story/Debounce
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placing a @story tag here stops Idea from rendering KDoc past the tag.

@terrakok
Copy link

I don't mind to copy my repo to the kotlinx.cotoutines 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants