Danny/kernel 364 documentation update async invocations section to use

[dprevoznik]

Description

Update the documentation to highlight streaming status updates as the recommended method for retrieving the status of an asynchronous invocation.

Testing

• mintlify dev works (see installation here)

Visual Proof

---

TL;DR

Updated the documentation for asynchronous invocations to recommend streaming status updates as the primary method for retrieving invocation status.

Why we made these changes

The previous documentation didn't clearly highlight the benefits of streaming for status updates. This change guides users toward a more efficient, real-time method, reducing the need for polling and improving the developer experience.

What changed?

• Rewrote the "Asynchronous Invocation" section to emphasize using the GET /invocations/{id}/events endpoint for streaming status.
• Relegated the polling method (GET /invocations/{id}) to a secondary alternative.
• Updated code examples to reflect the new recommendation.

^{Description generated by Mesa. Update settings}

[mesa-dot-dev]

Performed full review of 3f6f90b...1b5849e

Analysis

1. The JavaScript example contains a logical inconsistency where console.log statements appear after a streaming loop that may never complete, potentially misleading developers about the expected execution flow.

2. While the shift from polling to streaming represents architectural improvement, the documentation maintains both approaches without clear guidance on when polling might still be appropriate versus when streaming should be used exclusively.

3. The PR focuses on documentation changes but doesn't appear to address potential backward compatibility concerns for users currently implementing the polling approach.

Tip

⚡ Quick Actions

This review was generated by Mesa.

Actions:

• Configure your agents

Slash Commands:

• /review - Request a full code review
• /review latest - Review only changes since the last review
• /describe - Generate PR description. This will update the PR body or issue comment depending on your configuration
• /help - Get help with Mesa commands and configuration options

^{3 files reviewed | 0 comments | Review on Mesa | Edit Reviewer Settings}

[masnwilliams]

lgtm