docs: clarify `use:enhance` compatibility with `method="POST"`

[garysassano]

This PR aims to improve the documentation by explicitly stating that use:enhance is only compatible with forms using method="POST". Despite the fact that using use:enhance with other methods should throw an error, this limitation isn't clearly communicated in the current documentation.

This lack of clarity has led to misuse in several prominent projects, including:

• storybook
• sveltekit-superforms

By updating the documentation, we can help prevent similar misunderstandings and improve the developer experience when working with SvelteKit forms.

---

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.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 6d441f25a5fef1bdf761ed8d68d1d91be43ab38e

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