real-time-streams by mintlify[bot] · Pull Request #203 · mixpanel/docs

mintlify · 2026-08-28T19:21:09Z

Mintlify

11 threads from 1 user in Mintlify

docs/real-time-event-streams/overview.mdx
- Howard Chen: should the customer be aware of "Phase 1", "Phase 2"? view comment
- Howard Chen: Maybe just "Events Log" and "failed events log" is just one of possible status? view comment
- Howard Chen: will not have full payload for failed event log, only http response view comment
docs/real-time-event-streams/states-and-monitoring.mdx
- Howard Chen: we turn the status to error, including unhealthy (destination unreachable or rate limited), after 5 times retry. The ... view comment
- Howard Chen: I assume some metrics will not be supported in beta, as the callout section says view comment
- Howard Chen: we should mention that whenever a sync is paused due to errors, we will send the notification to the creator of the s... view comment
docs/real-time-event-streams/delivery-and-reliability.mdx
- Howard Chen: retries are processed in the same queue, not the different one view comment
- Howard Chen: the sync will be paused for 4xx auth error. see "[Event Sink Service] authentication failure (401 or 403)" in ERD view comment
docs/real-time-event-streams/setup.mdx
- Howard Chen: not support in beta. should we show this? view comment
- Howard Chen: I updated the correct variables here by using top-level fields of the default forward-all payload [https://app.notion... view comment
...and 1 more unresolved threads

- Created docs/real-time-event-streams/overview.mdx - Created docs/real-time-event-streams/setup.mdx - Created docs/real-time-event-streams/delivery-and-reliability.mdx - Created docs/real-time-event-streams/states-and-monitoring.mdx - Updated docs.json Mintlify-Source: dashboard-editor

- Updated docs/real-time-event-streams.mdx - Updated docs/real-time-event-streams/states-and-monitoring.mdx - Updated docs/real-time-event-streams/delivery-and-reliability.mdx - Updated docs/real-time-event-streams/overview.mdx - Updated docs/real-time-event-streams/setup.mdx - Updated docs.json Mintlify-Source: dashboard-editor

ryancurtis1 · 2026-08-28T19:22:42Z

@copilot resolve the merge conflicts in this pull request

greptile-apps · 2026-08-28T19:24:16Z

Confidence Score: 3/5

The PR does not appear safe to merge until the empty group root and contradictory failed-payload retention guidance are corrected.

Opening the configured group root still yields no documentation content, and customers receive mutually exclusive guidance about whether failed-event payload samples are available.

Files Needing Attention: docs/real-time-event-streams.mdx, docs/real-time-event-streams/states-and-monitoring.mdx, docs/real-time-event-streams/delivery-and-reliability.mdx

Important Files Changed

Filename	Overview
docs.json	Adds the Real-Time Event Streams navigation group and its four documentation pages.
docs/real-time-event-streams.mdx	Defines a frontmatter-only group root that still provides no overview content or redirect.
docs/real-time-event-streams/delivery-and-reliability.mdx	Documents delivery and retries, but its no-payload-retention contract conflicts with the monitoring page.
docs/real-time-event-streams/overview.mdx	Introduces the substantive product overview, beta scope, concepts, and navigation.
docs/real-time-event-streams/setup.mdx	Documents destination setup, authentication, filtering, and Liquid payload templates.
docs/real-time-event-streams/states-and-monitoring.mdx	Documents operational states and metrics, but incorrectly promises retained payload samples.

_{Reviews (3): Last reviewed commit: "Fix title and add description to real-ti..." | Re-trigger Greptile}

greptile-apps · 2026-08-28T19:24:19Z

+---
+title: "docs/real-time-event-streams"
+---


Empty documentation group root

When a reader opens the Real-Time Event Streams group root, this file renders an empty page with a path-like title instead of the available overview content.

greptile-apps · 2026-08-28T19:24:19Z

+
+- **Events delivered** — counts over the last 1 hour, 24 hours, and 7 days.
+- **Delivery success rate** — percentage of events that received a 2xx response within the retry window.
+- **Events failed after max retries** — count, with retained payload samples and destination response.


Conflicting payload retention contract

For events that exhaust retries, this page promises retained payload samples while the reliability page explicitly says outbound payloads are not retained, causing customers to rely on unavailable debugging data.

Suggested change

- **Events failed after max retries** — count, with retained payload samples and destination response.

- **Events failed after max retries** — count, with the destination response.

Knowledge Base Used: Data activation and pipelines

greptile-apps · 2026-08-28T19:24:19Z

+
+{/* PLACEHOLDER: Describe which changes can be made in place (event types, filters, template, auth) and which require pausing the Sync. Clarify how in-flight events are handled during edits. */}
+
+## Next steps
+
+<CardGroup cols={2}>
+  <Card title="Delivery and reliability" icon="shield-check" href="/docs/real-time-event-streams/delivery-and-reliability">
+    Retries, failed events log, and at-least-once delivery.
+  </Card>
+
+  <Card title="States and monitoring" icon="chart-line" href="/docs/real-time-event-streams/states-and-monitoring">
+    Destination and Sync states, plus how to monitor health.
+  </Card>
+</CardGroup>


Missing troubleshooting and FAQ

The new documentation ends without the troubleshooting and FAQ material required by the automatically discovered STREAM-310 acceptance criteria, leaving customers without consolidated recovery guidance for common configuration failures.

Source Used: Linear — Public docs

Resolve merge conflict in docs.json by taking the updated structure from main branch. The main branch restructured guides navigation, moving guides from guides-by-use-case/empower-your-team to a flatter structure with better grouping. Since the real-time-streams branch is adding documentation about real-time event streams and not modifying the guides structure, we accept the updated version from main. Co-authored-by: ryancurtis1 <176308989+ryancurtis1@users.noreply.github.com>

Copilot · 2026-08-28T19:25:33Z

@copilot resolve the merge conflicts in this pull request

✅ Merge conflicts resolved. I've merged the origin/main branch into real-time-streams and resolved the conflict in docs.json by accepting the updated guides navigation structure from main. The conflict was caused by guide path restructuring (e.g., guides-by-use-case/empower-your-team/mcp → guides/mcp), which is now reflected in the merged result.

The merge commit has been created and pushed.

mherrman · 2026-08-31T20:16:54Z

+- **Sync** — a rule that binds a set of filtered events and a Liquid payload template to a Destination.
+- **Failed events log** — a 72-hour record of events that could not be delivered after all retries, retained with the destination HTTP response for debugging.
+
+<Tip>


this is an empty callout in the docs. should add something here or remove

@copilot can you remove this empty callout please

Done. Removed the empty callout at line 59 of overview.mdx.

mherrman · 2026-08-31T20:17:46Z

@@ -0,0 +1,3 @@
+---
+title: "docs/real-time-event-streams"


to the greptile comments point the way this is displayed current should be updated. i don't think this page necessarily needs a bunch of content but we should have something (at least a title instead of the path)

@copilot can you fix this please

Done. Replaced the path-based title with "Real-Time Event Streams" and added a proper description to match the pattern of other index pages.

Remove the empty <Tip> block that contained only a placeholder comment at line 59 of docs/real-time-event-streams/overview.mdx. Co-authored-by: ryancurtis1 <176308989+ryancurtis1@users.noreply.github.com>

Replace the path-based title "docs/real-time-event-streams" with a proper customer-facing title and add a description to match the pattern of other index pages in the docs. Co-authored-by: ryancurtis1 <176308989+ryancurtis1@users.noreply.github.com>

mintlify Bot added 2 commits August 19, 2026 16:50

mintlify Bot requested review from a team as code owners August 28, 2026 19:21

mintlify Bot requested review from junhouse and rssebastian-mp August 28, 2026 19:21

mintlify Bot deployed to staging August 28, 2026 19:22 View deployment

ryancurtis1 marked this pull request as draft August 28, 2026 19:22

Copilot started work on behalf of ryancurtis1 August 28, 2026 19:23 View session

greptile-apps Bot reviewed Aug 28, 2026

View reviewed changes

Copilot finished work on behalf of ryancurtis1 August 28, 2026 19:26

Copilot AI requested a review from ryancurtis1 August 28, 2026 19:26

mintlify Bot deployed to staging August 28, 2026 19:27 View deployment

ryancurtis1 requested review from howardchen11 and mherrman August 28, 2026 20:25

mherrman reviewed Aug 31, 2026

View reviewed changes

Copilot started work on behalf of ryancurtis1 September 1, 2026 19:09 View session

Remove empty callout placeholder from overview.mdx

620465d

Remove the empty <Tip> block that contained only a placeholder comment at line 59 of docs/real-time-event-streams/overview.mdx. Co-authored-by: ryancurtis1 <176308989+ryancurtis1@users.noreply.github.com>

Copilot finished work on behalf of ryancurtis1 September 1, 2026 19:10

Copilot started work on behalf of ryancurtis1 September 1, 2026 19:11 View session

Copilot finished work on behalf of ryancurtis1 September 1, 2026 19:12

mintlify Bot deployed to staging September 1, 2026 19:21 View deployment

mintlify Bot deployed to staging September 1, 2026 19:24 View deployment

Navigation Menu

Uh oh!

real-time-streams - #203

real-time-streams#203
mintlify[bot] wants to merge 5 commits into
mainfrom
real-time-streams

mintlify Bot commented Aug 28, 2026 •

edited

Loading

Uh oh!

ryancurtis1 commented Aug 28, 2026

Uh oh!

greptile-apps Bot commented Aug 28, 2026 •

edited

Loading

Important Files Changed

Uh oh!

Uh oh!

greptile-apps Bot Aug 28, 2026

Uh oh!

greptile-apps Bot Aug 28, 2026

Uh oh!

greptile-apps Bot Aug 28, 2026

Uh oh!

Copilot AI commented Aug 28, 2026

Uh oh!

mherrman Aug 31, 2026

Uh oh!

ryancurtis1 Sep 1, 2026

Uh oh!

Copilot AI Sep 1, 2026

Uh oh!

mherrman Aug 31, 2026

Uh oh!

ryancurtis1 Sep 1, 2026

Uh oh!

Copilot AI Sep 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	- Events failed after max retries — count, with retained payload samples and destination response.
	- Events failed after max retries — count, with the destination response.

Uh oh!

Conversation

mintlify Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Mintlify

Uh oh!

ryancurtis1 commented Aug 28, 2026

Uh oh!

greptile-apps Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Confidence Score: 3/5

Important Files Changed

Uh oh!

Uh oh!

greptile-apps Bot Aug 28, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Aug 28, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Aug 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Aug 28, 2026

Uh oh!

mherrman Aug 31, 2026

Choose a reason for hiding this comment

Uh oh!

ryancurtis1 Sep 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2026

Choose a reason for hiding this comment

Uh oh!

mherrman Aug 31, 2026

Choose a reason for hiding this comment

Uh oh!

ryancurtis1 Sep 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mintlify Bot commented Aug 28, 2026 •

edited

Loading

greptile-apps Bot commented Aug 28, 2026 •

edited

Loading