Skip to content

Conversation

@laurenic0l
Copy link
Contributor

@laurenic0l laurenic0l commented Jan 22, 2026

Here's the first draft of the MarkdownViewer documentation. POM file should be updated with 25.11

closes #659

@laurenic0l laurenic0l added status: needs-snapshot Update to the latest snapshot before this PR can be merged. status: waiting-for-review The PR is ready. Waiting for team members to review. labels Jan 22, 2026
Copy link
Member

@hyyan hyyan left a comment

Choose a reason for hiding this comment

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

@laurenic0l This article has a few issues. The flow is not completely smooth, and it makes some incorrect assumptions.

  1. Conflates "streaming" with "progressive rendering"

    • append() works independently - content appears immediately if progressiveRender is off
    • "Streaming methods" section title is misleading
    • Streaming is about receiving data from server
    • Progressive rendering is about displaying it character-by-character
  2. Missing dependency clarity

    • isRendering() only meaningful when progressiveRender is enabled
    • stop(), flush(), whenRenderComplete() only work with progressiveRender on
    • These dependencies aren't explained
  3. Auto-scroll placement

    • Presented as if related to streaming, but it's completely independent
    • Can be used with or without streaming/progressive rendering
  4. Organization implies wrong flow

    • Suggests you need "streaming methods" for progressive rendering
    • Reality: you can append() without progressiveRender

I suggest this structure, please verify:

  1. Setting content
  2. Appending content (for any incremental updates)
  3. Auto-scroll (independent feature)
  4. Progressive rendering (visual typewriter effect)
    • Enable it
    • Render speed
    • Render state (isRendering)
    • Controlling rendering (stop/flush)
    • Waiting for completion (whenRenderComplete)
  5. Clearing content
  6. Syntax highlighting

@laurenic0l laurenic0l added status: waiting-for-author Review is done. Waiting for the PR author to apply changes or respond. and removed status: waiting-for-review The PR is ready. Waiting for team members to review. labels Jan 22, 2026
@laurenic0l laurenic0l requested a review from hyyan January 26, 2026 23:20
@laurenic0l laurenic0l force-pushed the 659-markdownviewer-doc branch from 62c2859 to fde2508 Compare January 27, 2026 03:04
@laurenic0l laurenic0l added status: waiting-for-review The PR is ready. Waiting for team members to review. and removed status: waiting-for-author Review is done. Waiting for the PR author to apply changes or respond. labels Jan 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: needs-snapshot Update to the latest snapshot before this PR can be merged. status: waiting-for-review The PR is ready. Waiting for team members to review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document MarkdownViewer component

3 participants