[Durable Objects] Docs enhancement part 1 #17794
Merged
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
…alks about the strength of DO.
Moving Changelog out of Platform into its own item. Moving Glossary into Reference. Updating Changelog YAML with new Changelog location.
Oxyjun
requested review from
a team,
elithrar,
joshthoward and
vy-ton
as code owners
Oxyjun
added
the
product:durable-objects
Deploying cloudflare-docs with
|
| Latest commit: |
19c3043
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f05011be.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://jun-do-docs-enhancement-part.cloudflare-docs-7ou.pages.dev |
Contributor
|
This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
|
Contributor
Oxyjun
requested review from
GregBrimble,
KianNH,
WalshyDev and
pedrosousa
as code owners
vy-ton
requested changes
Oct 28, 2024
vy-ton
approved these changes
Oct 31, 2024
Maddy-Cloudflare
approved these changes
Oct 31, 2024
elithrar
pushed a commit
that referenced
this pull request
Nov 6, 2024
* Adding glossary terms for DO where relevant. * Lifting text from the Blog to define DO, adding one paragraph which talks about the strength of DO. * Moving the Glossary into "Reference" section. * General reordering of sidebar. Moving Changelog out of Platform into its own item. Moving Glossary into Reference. Updating Changelog YAML with new Changelog location. * Adding redirects. * Adding missing / * Reverting Overview text for now.
harshil1712
pushed a commit
that referenced
this pull request
Dec 3, 2024
* Adding glossary terms for DO where relevant. * Lifting text from the Blog to define DO, adding one paragraph which talks about the strength of DO. * Moving the Glossary into "Reference" section. * General reordering of sidebar. Moving Changelog out of Platform into its own item. Moving Glossary into Reference. Updating Changelog YAML with new Changelog location. * Adding redirects. * Adding missing / * Reverting Overview text for now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Summary
1. Improved the Overview page.- Added "What is a Durable Object?". Lifted paragraphs from this blog post.
- Added "Utilize Durable Objects". Lifted one paragraph from the blog post.
- Added "Get started" button.
2. Added glossary tooltips across the docs.
3. Moved Changelog out of "Platform", and into its own item.
4. Moved up REST API link to sit under "Runtime API".
5. Moved Glossary into "Reference".
The full restructure can be tackled in a separate PR to even out the review burden.
Screenshots (optional)
Documentation checklist