Enhance countdown-py README with comprehensive documentation #1
Conversation
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
Added comprehensive documentation for the Python countdown example: **Content Added:** - Problem statement (resource waste, crash recovery) - Solution explanation (durable sleep benefits) - Real-world use cases (reminders, SLA monitors, rate limiting) - Step-by-step code walkthrough - Crash recovery explanation - Running instructions with example commands - Configuration options (ntfy.sh, Slack, Discord) - Failure scenario testing procedures - Key concepts (durable sleep, idempotency, resource efficiency) - Production considerations - Related examples **Structure:** - Clear sections with progressive detail - Code examples with explanations - Testing procedures for crash recovery - Multiple notification backend examples Updated repo description and topics: resonate, python, durable-execution, countdown, notifications Note: Removed serverless/cloud function sections as Python SDK does not yet have shims for those platforms. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
flossypurse
force-pushed
the
feature/enhance-countdown-py-readme
branch
from
dd0ea35 to
305a0cd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Comprehensive documentation for the Python countdown example demonstrating durable sleep.
Changes
Documentation Added
Metadata
Why This Matters
The countdown example is perfect for demonstrating durable sleep - a core Resonate feature that enables:
This README makes it easy for developers to understand and run the example.
Testing
Example already has working code. README provides clear instructions for: