Skip to content

docs(durable): align local execution guidance - #226

Merged
tkkhq merged 5 commits into
mainfrom
docs/durable-local-contract
Sep 24, 2026
Merged

tkkhq merged 5 commits into
mainfrom
docs/durable-local-contract

Conversation

@tkkhq

@tkkhq tkkhq commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Tracking

Why

  • the CLI runs durable functions locally, while its public docs still say durable execution is cloud-only and refused by the local server
  • the durable overview says executions run for hours, while the platform execution timeout is 366 days

Summary

  • document volcano durable as the local counterpart to volcano cloud durable
  • document immediate local waits and the LOCAL_DURABLE_REAL_TIME override
  • use the public HOBBY and SUPERAGENT plan names in CLI documentation
  • align the execution-duration wording with the 366-day platform limit

Verification

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

@tkkhq
tkkhq marked this pull request as ready for review September 23, 2026 22:30
@tkkhq
tkkhq requested a review from a team as a code owner September 23, 2026 22:30
Copilot AI balanced review requested due to automatic review settings September 23, 2026 22:30

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Copy link
Copy Markdown
Contributor

[P2] Clarify that top-level resource commands do not fall back to cloud

In docs/README.md:56–58, the updated paragraph includes volcano durable … in the claim that commands use the local environment when running and otherwise use the cloud project. However, NewResourceCommands wires durable commands through withLocalConfig in internal/cmd/local/local.go, which always loads local server metadata. If the local container is absent or stopped, FetchInfo returns ErrLocalNotRunning; there is no cloud fallback. A user following this guidance to run volcano durable list against their cloud project would get an error instead.

Please state that top-level resource commands target local development and that cloud operations require the explicit volcano cloud … prefix.

@shawnwu-kong shawnwu-kong left a comment

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.

approve with a p2

@tkkhq

tkkhq commented Sep 24, 2026

Copy link
Copy Markdown
Contributor Author

Fixed in b0dce7c. The overview now states that top-level resource commands always target local development and require the explicit volcano cloud … prefix for cloud operations; the same stale active-context wording was also removed from docs/functions.md.

@tkkhq
tkkhq merged commit a34b54f into main Sep 24, 2026
9 checks passed
@tkkhq
tkkhq deleted the docs/durable-local-contract branch September 24, 2026 01:49
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.

3 participants