restatedev / restatedev/docs-restate
Document suspension/inactivity more at length
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3
- Forks
- 16
- Avg merge
- 5d 4h
- Merged PRs (30d)
- 24
Description
Explain why this happens, explain what knobs can be tuned in the SDK/ handler/ service level.
Provide an example of a function call and explain at what point the function might be suspended and what to observe in the UI when it happens,
then when it resumes.
As this is a concept that is unique and new to us
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing documentation for suspension or inactivity and review how the SDK, handler, and service levels are described. Add the requested explanation, a function-call example, tuning options, and the UI signals to observe during suspension and resumption. Done means a newcomer can understand why suspension occurs and how to recognize it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100