Skip to content
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

docs: fix naming in 60-adapter-cloudflare.md #13560

Merged
merged 2 commits into from
Mar 14, 2025

Conversation

kotkoroid
Copy link
Contributor

It appears that the SvelteKit adapters for Cloudflare are distinct, with @sveltejs/adapter-cloudflare specifically designed for Cloudflare Pages, whereas @sveltejs/adapter-cloudflare-workers is intended for Cloudflare Workers.

This pull request aims to rectify a documentation inconsistency in the @sveltejs/adapter-cloudflare documentation page, rather than proposing a rename to @sveltejs/adapter-cloudflare-pages, which would indeed help to avoid confusion.

The current documentation for @sveltejs/adapter-cloudflare suggests that it should be used to emulate Cloudflare Workers-specific values during local development. However, given that this adapter is actually tailored for Cloudflare Pages, this information seems to be inaccurate.


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • [ X ] This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • [ X ] Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Sorry, something went wrong.

Copy link

changeset-bot bot commented Mar 8, 2025

⚠️ No Changeset found

Latest commit: c8e6345

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@benmccann benmccann requested a review from eltigerchino March 14, 2025 16:18
@benmccann benmccann added the documentation Improvements or additions to documentation label Mar 14, 2025
@svelte-docs-bot
Copy link

Copy link
Member

@Rich-Harris Rich-Harris left a comment

Choose a reason for hiding this comment

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

thanks!

@Rich-Harris Rich-Harris merged commit e2babbb into sveltejs:main Mar 14, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants