docs: revise key concepts, add section indices#105
Merged
Conversation
- Rewrite key-concepts.md with richer content from service docs - Add DurableContext section with multi-language code examples - Add Checkpoints section with 5-step sequence - Expand Replay section with checkpoint log sequence and determinism note - Add replay walkthrough with language-neutral step-by-step trace - Fix operations list with links to SDK reference pages and add wait-for-condition - Move Python-specific content (two SDKs, decorators) to sdk-reference/languages/ - Add Language Guides section under SDK Reference (TypeScript, Python, Java) - Add toc.permalink = true for heading anchor links - Revise getting-started/index.md as section landing page - Add verified multi-language code examples for durable-context and execution-model closes #103
|
|
||
| When your code calls a durable operation, the SDK follows this sequence: | ||
|
|
||
| 1. **Check for an existing checkpoint** if this operation already completed in a |
Contributor
There was a problem hiding this comment.
Since this is high level intro for checkpoints, we don't need to mention that checkpoint will not save result for large size, correct?
Contributor
Author
There was a problem hiding this comment.
Great call-out, thank you 😁
Yes, I think that belongs in the more detailed section for child context and step.
ayushiahjolia
approved these changes
Apr 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of changes:
Reviewer note: at this point the
docs/sdk-reference/languagesfiles are largely placeholders.Issue #, if available:
closes #103
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.