Skip to content
This repository was archived by the owner on Nov 12, 2025. It is now read-only.

Quickstart update#626

Merged
gvdongen merged 5 commits intomainfrom
quickstart_update
Jun 11, 2025
Merged

Quickstart update#626
gvdongen merged 5 commits intomainfrom
quickstart_update

Conversation

@gvdongen
Copy link
Contributor

@gvdongen gvdongen commented Jun 10, 2025

This pull request updates the docs/get_started/quickstart.mdx file to improve the clarity and usability of the quickstart guide for the Restate SDK. The changes include enhancements to the instructions, additional visual aids, and updates to code examples to align with best practices. Below is a summary of the key updates:

Improvements to Instructions and Visual Aids:

  • Updated all references to the Restate UI playground to include explicit URLs (http://localhost:9070) and added screenshots (playground.png) for better guidance. [1] [2] [3] [4] [5]
  • Added a new step to demonstrate how the service handles failures by sending a request for "Alice" and showing retries in the logs and UI, along with an explanatory screenshot (quickstart_retries.png). [1] [2] [3] [4] [5]

Code and Dependency Updates:

  • Simplified the Python quickstart by removing the virtual environment setup and replacing the Hypercorn server command with uv run .. Also updated the example file path for clarity. [1] [2]
  • Added a prerequisite for the uv dependency in the Python quickstart section.

Durable Execution Explanation:

  • Enhanced the explanation of Durable Execution by replacing textual descriptions with an interactive example and a tip admonition linking to the Durable Execution documentation page. [1] [2] [3] [4] [5]

These updates aim to make the quickstart guide more user-friendly and informative for developers using the Restate SDK.

Fixes restatedev/examples#239

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Jun 11, 2025

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: c98b56b
Status: ✅  Deploy successful!
Preview URL: https://dcfdf86c.documentation-beg.pages.dev
Branch Preview URL: https://quickstart-update.documentation-beg.pages.dev

View logs

@gvdongen gvdongen merged commit fdf0455 into main Jun 11, 2025
9 checks passed
@gvdongen gvdongen deleted the quickstart_update branch June 11, 2025 08:11
@github-actions github-actions bot locked and limited conversation to collaborators Jun 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant