Skip to content

Stream docs#238

Merged
svix-gabriel merged 1 commit intomainfrom
gabriel/real-stream
Oct 8, 2025
Merged

Stream docs#238
svix-gabriel merged 1 commit intomainfrom
gabriel/real-stream

Conversation

@svix-gabriel
Copy link
Contributor

@svix-gabriel svix-gabriel commented Oct 8, 2025

Stream docs (#226)
This closes https://github.com/svix/monorepo-private/issues/9127
alongside https://github.com/svix/svix-webhooks-private/pull/4526

The docs try to explain high level concepts (what is a Stream, Sink,
Event Types, Events), the semantics of dispatch (retries, batching), and
transformations.

Screenshot 2025-09-30 at 10 26 59

To review:

  • pull down the changes locally
  • run yarn start and navigate to the Stream section.

The screenshots, side by side with the text, are pretty integral to the
flow of the documentation. So it's better to read them side by side.

Random things to note:

  • There are some plaintext authtoken looking things, these are from fake
    or revoked tokens, so they're fine to include in source code.
  • In quite a few places, we link to the API docs for stream. However,
    these docs won't be public until
    https://github.com/svix/svix-webhooks-private/pull/4526 is merged, so
    the links may not work when clicking locally.

@svix-gabriel svix-gabriel requested a review from a team as a code owner October 8, 2025 15:19
@vercel
Copy link

vercel bot commented Oct 8, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
svix-docs Ready Ready Preview Comment Oct 8, 2025 3:39pm

@svix-lucho
Copy link
Contributor

In case you can't access Vercel

  [cause]: Error: Docusaurus found broken links!
  
  Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
  Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
  
  Exhaustive list of all broken links found:
  - Broken link on source page path = /stream/event-types/introduction:
     -> linking to ./sinks/intro_to_sinks (resolved as: /stream/event-types/sinks/intro_to_sinks)
  - Broken link on source page path = /stream/introduction:
     -> linking to ./sink-types/http (resolved as: /stream/sink-types/http)
     -> linking to ./sink-types/s3 (resolved as: /stream/sink-types/s3)
     -> linking to ./sink-types/gcs (resolved as: /stream/sink-types/gcs)
     -> linking to ./sink-types/azure_blob (resolved as: /stream/sink-types/azure_blob)
     -> linking to ./sink-types/otel_trace (resolved as: /stream/sink-types/otel_trace)
  - Broken link on source page path = /stream/sinks/introduction:
     -> linking to ../sink-types/http (resolved as: /stream/sink-types/http)
     -> linking to ../sink-types/otel_trace (resolved as: /stream/sink-types/otel_trace)
     -> linking to ../sink-types/s3 (resolved as: /stream/sink-types/s3)
     -> linking to ../sink-types/gcs (resolved as: /stream/sink-types/gcs)
     -> linking to ../sink-types/azure_blob (resolved as: /stream/sink-types/azure_blob)
     -> linking to ../sink-types/poller (resolved as: /stream/sink-types/poller)

@svix-gabriel svix-gabriel merged commit 87c33d3 into main Oct 8, 2025
3 checks passed
@svix-gabriel svix-gabriel deleted the gabriel/real-stream branch October 8, 2025 16:13
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.

2 participants