Skip to content

New Vite plugin docs for local development #20586

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 38 commits into from
Apr 7, 2025
Merged

Conversation

korinne
Copy link
Contributor

@korinne korinne commented Mar 6, 2025

Summary

  • Creates a new folder for local development, containing guides for Wrangler (using wrangler dev) and the new Cloudflare Vite plugin

Documentation checklist

jamesopstad and others added 4 commits March 3, 2025 15:42
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hyperlint Review is complete!

Hyperlint Vale Style Guide Review

Reviewed 3 files and found 3 issues.

See the inline comments and suggestions below.

Hyperlint Link Check Review

Reviewed 3 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.

Copy link
Contributor

github-actions bot commented Mar 6, 2025

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.

korinne and others added 4 commits March 7, 2025 13:18
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
@korinne korinne requested a review from jamesopstad March 7, 2025 22:52
Copy link
Contributor

@irvinebroque irvinebroque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-actions github-actions bot added size/m and removed size/l labels Apr 5, 2025
Copy link
Contributor

@irvinebroque irvinebroque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

Copy link
Contributor

@jamesopstad jamesopstad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I've made a few suggestions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned in my earlier comment, I think it would be good to move this content to the overview.

@korinne korinne merged commit 40e231b into production Apr 7, 2025
11 checks passed
@korinne korinne deleted the korinne-vite-plugin-docs branch April 7, 2025 18:53
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* Initial Vite plugin docs

* Update src/content/docs/workers/vite-plugin/api.mdx

Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>

* Update src/content/docs/workers/vite-plugin/api.mdx

Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>

* adds a directory structure for local development docs,  and adds a Vite plugin section

* Update src/content/docs/workers/local-development/vite.mdx

Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>

* Update src/content/docs/workers/local-development/wrangler.mdx

Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>

* fix some broken links

* consolidates current local dev docs under new directory, and includes
 ⛅️ wrangler 3.95.0 (update available 3.114.1)
---------------------------------------------- in Overview page

* Uses new PackageManager component in local-development/wrangler.mdx

* adds bindings_per_env.mdx under src/content/partials/workers

* Adds guidance for when to use Wrangler vs Vite, adds Vite to the binding comparison

* updates Wrangler local development guide, and partial for local vs remote dev

* updates overview page to make more concise

* fixes broken links

* Update src/content/docs/workers/local-development/vite.mdx

Co-authored-by: James Opstad <[email protected]>

* Update src/content/docs/workers/local-development/vite.mdx

Co-authored-by: James Opstad <[email protected]>

* Update src/content/docs/workers/local-development/vite.mdx

Co-authored-by: James Opstad <[email protected]>

* Update src/content/docs/workers/local-development/index.mdx

Co-authored-by: James Opstad <[email protected]>

* moves local development section nearer to testing section

* cleans up text in choosing between wrangler and vite

* updates overview page for local development

* update overview page, add working with data page

* updates local development docs

* Update src/content/docs/workers/local-development/local-data.mdx

Co-authored-by: James Opstad <[email protected]>

* Update src/content/docs/workers/local-development/local-data.mdx

Co-authored-by: James Opstad <[email protected]>

* Update src/content/docs/workers/local-development/wrangler-vs-vite.mdx

Co-authored-by: Kody Jackson <[email protected]>

* Update src/content/docs/workers/local-development/remote-data.mdx

Co-authored-by: Kody Jackson <[email protected]>

* Update src/content/docs/workers/local-development/local-data.mdx

Co-authored-by: Kody Jackson <[email protected]>

* Update src/content/docs/workers/local-development/local-data.mdx

Co-authored-by: Kody Jackson <[email protected]>

* Update src/content/docs/workers/local-development/local-data.mdx

Co-authored-by: Brendan Irvine-Broque <[email protected]>

* Update src/content/docs/workers/local-development/index.mdx

Co-authored-by: James Opstad <[email protected]>

* adds updates to remove separate vite vs wrangler docs, small changes

* updates local-data.mdx

* Update src/content/docs/workers/local-development/remote-data.mdx

---------

Co-authored-by: James Opstad <[email protected]>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: Kody Jackson <[email protected]>
Co-authored-by: Brendan Irvine-Broque <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:workers Related to Workers product size/m
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants