Skip to content

docs(durable): align local runtime guidance - #347

Merged
tkkhq merged 3 commits into
mainfrom
fix/durable-local-guidance
Sep 24, 2026
Merged

tkkhq merged 3 commits into
mainfrom
fix/durable-local-guidance

Conversation

@tkkhq

@tkkhq tkkhq commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Tracking

Why

  • the public SDK docs omit the durable client, authoring workflow, local wait behavior, callback limit, and 366-day execution limit

Summary

  • document durable execution clients and Python authoring in the published functions guide
  • use a separate platform-user client for owner-scoped execution management
  • document immediate local waits, persistence across local restarts, LOCAL_DURABLE_REAL_TIME, and the callback limit
  • align duration wording with the 366-day platform limit

Verification

  • git diff --check origin/main...HEAD
  • shared Volcano documentation linter passed against docs/

@tkkhq
tkkhq force-pushed the fix/durable-local-guidance branch from 19c87d9 to 294b885 Compare September 24, 2026 00:08
@tkkhq
tkkhq marked this pull request as ready for review September 24, 2026 00:09
@tkkhq
tkkhq requested a review from a team as a code owner September 24, 2026 00:09

Copy link
Copy Markdown

One documentation gap in the new local development walkthrough: volcano durable deploy --all only deploys functions explicitly declared with kind: durable in volcano-config.yaml. The guide currently goes from the decorated Python handler straight to that command without showing the required manifest declaration. Adding @durable alone does not make the CLI discover it as a durable function, so following these steps without that declaration fails with no durable functions declared.

Could you add a minimal manifest for charge-order, along with the function's source location and requirements.txt containing volcano-sdk-python, or link to a complete setup guide before the commands? The new local development section in the README should also mention the manifest prerequisite.

Relevant section:

## Run durable functions locally
Deploy and start the same handler through the local durable engine:
```bash
volcano start
volcano durable deploy --all
volcano durable start charge-order --input '{"order_id":"order-9"}'

@tkkhq tkkhq changed the title fix(durable): align local runtime guidance docs(durable): align local runtime guidance Sep 24, 2026
@tkkhq
tkkhq enabled auto-merge (squash) September 24, 2026 00:30
@tkkhq
tkkhq merged commit 6603b5b into main Sep 24, 2026
10 checks passed
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