Skip to content

feat(durable-streams): Documentation - #5248

Open
juliusgeo wants to merge 7 commits into
mainfrom
durable_stream_docs
Open

juliusgeo wants to merge 7 commits into
mainfrom
durable_stream_docs

Conversation

@juliusgeo

Copy link
Copy Markdown
Contributor

Description

Adds documentation for the durable streams feature.

image

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation change (pure documentation change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking changes to code which doesn't change any behaviour)
  • Performance improvement (non-breaking change which improves performance)
  • CI (any automation pipeline changes)
  • Chore (changes which are not directly related to any business logic)
  • Test changes (add, refactor, improve or change a test)
  • This change requires a documentation update

Checklist

Changes have been:

  • Documented (where applicable)
  • Added to CHANGELOG (where applicable) -- see Keep a Changelog

🤖 AI Disclosure
  • I acknowledge that an LLM was used in the creation of this Pull Request, in accordance with Hatchet's AI_POLICY.md.
  • Details: [e.g. generating tests, writing docs]

@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
hatchet-docs Ready Ready Preview Oct 30, 2026 3:48pm UTC

Request Review

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 19, 2026
@greptile-apps

greptile-apps Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 4/5

[Medium impact] The Python SDK API change reaches callers that reset durable-stream topics.

The repository’s release requirement must be satisfied before merging the TypeScript example change.

Summary

Adds a durable streams guide with publishing, cursor resume, reset, and retry examples.

  • Readers can find examples for publishing and catching up on durable streams.
  • Python callers reset stream topics through an async call.
  • The search checks include the durable-streams guide for streaming queries.

Reviews (6) · Last reviewed commit: "update docs etc" · Reviewed by Greptile

Comment thread frontend/docs/content/docs/v1/meta.json Resolved
@github-actions github-actions Bot added sdk-ts Related to the Typescript SDK sdk-go Related to the Go SDK sdk-py Related to the Python sdk sdk-ruby Related to the Ruby SDK labels Oct 30, 2026
Comment on lines +83 to +85
export async function resetToCursor() {
// > Reset to a cursor
let cursor: string | undefined;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 TypeScript release records are missing

The new resetToCursor example changes sdks/typescript/src/**, but this PR includes no TypeScript SDK version bump or changelog entry. AGENTS.md requires both for changes under that directory, including examples. Add them before merging.

Context Used: AGENTS.md (source)

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

they're just examples, not changes to the actual SDK

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You're right that this only adds an example and doesn't change the SDK's runtime behavior or API. I flagged it because the repo's AGENTS.md currently applies the version-bump/changelog requirement to all changes under sdks/typescript/src/**, and this example is inside that path. If examples are meant to be exempt, that instruction should be narrowed; as written, it includes them.

This branch was successfully deployed

1 active deployment
Preview — 2f35e414 Deployed Oct 30, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation sdk-go Related to the Go SDK sdk-py Related to the Python sdk sdk-ruby Related to the Ruby SDK sdk-ts Related to the Typescript SDK

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants