Skip to content

[DO] Improving Getting started for DO. #21901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 24, 2025

Conversation

Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Apr 22, 2025

Summary

  1. Using syncKey across JS / TS code blocks so that users who are using one language can just switch tabs once.
  2. Adding a separate "Summary and final code" heading, which includes the full final code of index.ts. This section also explicitly lists the main steps of the tutorial.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions github-actions bot added the product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ label Apr 22, 2025
Copy link
Contributor

hyperlint-ai bot commented Apr 22, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Improved the getting started documentation for Durable Objects by enhancing code block synchronization and providing a comprehensive summary section.

  • Implemented syncKey for JavaScript and TypeScript code blocks to facilitate easier navigation for users.
  • Added a new section summarizing the tutorial steps and including the complete final code for index.ts.
  • Clarified the main objectives achieved by completing the tutorial.

Modified Files

  • src/content/docs/durable-objects/get-started.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

Co-authored-by: Maddy <130055405+Maddy-Cloudflare@users.noreply.github.com>
@Oxyjun Oxyjun merged commit ab2114d into production Apr 24, 2025
12 checks passed
@Oxyjun Oxyjun deleted the jun/do/getting-started-full-code branch April 24, 2025 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants