update various framework guides (hono, react etc.) #21367
Conversation
emily-shen
requested review from
a team,
GregBrimble,
IgorMinar,
ToriLindsay and
aninibread
as code owners
|
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 SummaryUpdated the Hono documentation to enhance clarity and provide a more structured approach for creating full-stack applications with Hono and React.
Modified Files
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 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 |
emily-shen
requested review from
a team,
WalshyDev,
irvinebroque and
mikenomitch
as code owners
emily-shen
force-pushed
the
emily/hono-new
branch
2 times, most recently
from
f9ccad0 to
c673b99
Compare
emily-shen
changed the title
emily-shen
force-pushed
the
emily/hono-new
branch
from
c673b99 to
b6997e2
Compare
jamesopstad
left a comment
jamesopstad
left a comment
There was a problem hiding this comment.
Looks great! Just added a few suggestions.
| Use the [`create-cloudflare`](https://www.npmjs.com/package/create-cloudflare) CLI (C3) to set up a new project. C3 will create a new project directory, use code from the official Hono template, and provide the option to deploy instantly. | ||
|
|
||
| To use `create-cloudflare` to create a new Hono project with <InlineBadge preset="beta" /> Workers Assets, run the following command: | ||
| **Start from CLI** - scaffold a full-stack app with a Hono API, React SPA and the Cloudflare Vite plugin for lightning-fast development. |
There was a problem hiding this comment.
| **Start from CLI** - scaffold a full-stack app with a Hono API, React SPA and the Cloudflare Vite plugin for lightning-fast development. | |
| **Start from the CLI** - scaffold a full-stack app with a Hono API, React SPA and the Cloudflare Vite plugin for lightning-fast development. |
| </FileTree> | ||
|
|
||
| Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including [Cloudflare's own](/workers/ci-cd/builds/). | ||
| `wrangler.jsonc` is your [Wrangler configuration file](/workers/wrangler/configuration/). |
There was a problem hiding this comment.
| `wrangler.jsonc` is your [Wrangler configuration file](/workers/wrangler/configuration/). | |
| `wrangler.jsonc` is your [Worker configuration file](/workers/wrangler/configuration/). |
There was a problem hiding this comment.
we use "wrangler configuration file" everywhere else across the docs, unless you feel strongly about it, i'd prefer to keep it consistent. Especially since that file configures more than just your worker (e.g. resources), for better or worse 🥲
There was a problem hiding this comment.
Fair enough. I used 'Worker config file' in the Vite plugin docs but we can revisit this at a later date.
| Use the [`create-cloudflare`](https://www.npmjs.com/package/create-cloudflare) CLI (C3) to set up a new project. C3 will create a new project directory, use code from the official React template, and provide the option to deploy instantly. | ||
|
|
||
| To use `create-cloudflare` to create a new React project with <InlineBadge preset="beta" /> Workers Assets, run the following command: | ||
| **Start from CLI** - scaffold a full-stack app with a React SPA, Cloudflare Workers API, and the Cloudflare Vite plugin for lightning-fast development. |
There was a problem hiding this comment.
| **Start from CLI** - scaffold a full-stack app with a React SPA, Cloudflare Workers API, and the Cloudflare Vite plugin for lightning-fast development. | |
| **Start from the CLI** - scaffold a full-stack app with a React SPA, Cloudflare Workers API, and the Cloudflare Vite plugin for lightning-fast development. |
Co-authored-by: James Opstad <[email protected]>
korinne
left a comment
korinne
left a comment
There was a problem hiding this comment.
Looks great, thank you so much @emily-shen
* update hono docs * f * add bindings partial * update vue a bit * add bindings partial to hono * and the rest of them * Apply suggestions from code review Co-authored-by: James Opstad <[email protected]> * add links to vite plugin --------- Co-authored-by: James Opstad <[email protected]>
8 participants
Summary
update hono, react and vue docs
Add a bindings partial with a nice big link button and apply it everywhere
remove redundant c3 steps everywhere
remove unhelpful 'static assets' section, because this use of 'static assets' means something different to how we use it everywhere else. replaced it with 'routing' where helpful (just for the SPAs, basically)
Screenshots (optional)
Documentation checklist