real-time-streams - #203
Conversation
- 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
|
@copilot resolve the merge conflicts in this pull request |
Confidence Score: 5/5The PR appears safe to merge with no blocking failure remaining. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| docs.json | Adds the Real-Time Event Streams documentation group beneath Data Out. |
| docs/real-time-event-streams/overview.mdx | Introduces the feature overview, beta scope, concepts, and comparison with Data Pipelines. |
| docs/real-time-event-streams/setup.mdx | Documents destination setup, filtering, authentication, and Liquid payload templates. |
| docs/real-time-event-streams/delivery-and-reliability.mdx | Documents delivery guarantees, retries, failure handling, and backpressure. |
| docs/real-time-event-streams/states-and-monitoring.mdx | Documents Sync and Destination states, audit logging, and monitoring metrics. |
Reviews (2): Last reviewed commit: "Merge branch 'origin/main' into real-tim..." | Re-trigger Greptile
![greptile-apps[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| --- | ||
| title: "docs/real-time-event-streams" | ||
| --- |
There was a problem hiding this comment.
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.
|
|
||
| - **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. |
There was a problem hiding this comment.
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.
| - **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
|
|
||
| {/* 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> |
There was a problem hiding this comment.
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>
✅ Merge conflicts resolved. I've merged the The merge commit has been created and pushed. |
| - **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> |
There was a problem hiding this comment.
this is an empty callout in the docs. should add something here or remove
| @@ -0,0 +1,3 @@ | |||
| --- | |||
| title: "docs/real-time-event-streams" | |||
There was a problem hiding this comment.
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)
Mintlify
11 threads from 1 user in Mintlify