Get started updates #20460
Get started updates #20460
Conversation
|
Howdy and thanks for contributing to our repo. 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. |
|
This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
|
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hyperlint Review is complete!
Hyperlint Vale Style Guide Review
Reviewed 4 files and found 1 issues.
See the inline comments and suggestions below.
Hyperlint Link Check Review
Reviewed 4 files and found 0 issues.
We are upgrading our reviewer model! Going forward, our model will learn your particular style - which comments you all accept and reject, so that it can further personalize its suggestions.
What is Hyperlint?
Hyperlint is an AI agent that helps you write, edit, and maintain your documentation. It can review, edit, and suggest fixes for your documentation.
Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.
| * Recommendations on Cloudflare products to use for specific storage or state needs | ||
| - Using `<xml>` tags to structure the prompt | ||
| - API and usage examples for products and use-cases | ||
| - Guidance on how to generate configuration (e.g. `wrangler.jsonc`) as part of the models response. |
There was a problem hiding this comment.
Identified issues
- Vale Style Guide - (cloudflare.LatinTerms-warning) Use 'for example' instead of 'e.g.', but consider rewriting the sentence.
Proposed fix
| - Guidance on how to generate configuration (e.g. `wrangler.jsonc`) as part of the models response. | |
| - Guidance on how to generate configuration (for example, `wrangler.jsonc`) as part of the models response. |
I replaced 'e.g.' with 'for example' to align with the style guide recommendation. The term 'e.g.' was not in a code reference, so the correction is applicable.
|
CI run failed: build logs |
irvinebroque
left a comment
irvinebroque
left a comment
There was a problem hiding this comment.
Think there's overlap between this and #19927
The content added here:
https://korinne-get-started-updates.preview.developers.cloudflare.com/workers/get-started/
Seems most relevant here, or somewhere else that can be linked to:
https://developers.cloudflare.com/workers/
...that explains what a Worker is. For example, lots of docs pages link to: https://developers.cloudflare.com/workers/reference/how-workers-works/ — and what you're adding here could make sense to weave into that.
Tactically, for getting started docs, I would say that:
- current quickstarts page can probably just be removed, redirect to templates or examples
/workers/get-started/dashboard/needs clear button that links to dash — and — should the page actually be called "Dashboard" or should it really be called something like "Import a git repository"?/workers/playgroundseems like a Getting Started concern... (https://developers.cloudflare.com/workers/playground/)
|
This has been sitting for a bit and has gotten merge conflicts. Closing out for now but feel free to re-open! |
7 participants
Summary
Documentation checklist