Skip to content

Conversation

@emily-shen
Copy link
Contributor

Summary

now structured around testing method (vitest, miniflare, wrangler) rather than unit/integration test which seems more logical to me.

move 'write your first test' in vitest to be at the top level in that section so its more prominent, and the two migration guides into their own section.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 9, 2025

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /workers/testing/integration-testing/
  • /workers/testing/unit-testing/
  • /workers/testing/vitest-integration/get-started/
  • /workers/testing/vitest-integration/get-started/migrate-from-miniflare-2/
  • /workers/testing/vitest-integration/get-started/migrate-from-unstable-dev/
  • /workers/testing/vitest-integration/get-started/write-your-first-test/

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 9, 2025

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 Summary

Restructured the testing documentation for Workers to improve clarity and organization.

  • Reorganized documentation structure around testing methods (Vitest, Miniflare, Wrangler) instead of unit/integration tests.
  • Moved 'write your first test' section in Vitest to a more prominent position.
  • Created a separate section for migration guides.

Modified Files

  • src/content/docs/workers/testing/index.mdx
  • src/content/docs/workers/testing/miniflare/index.mdx
  • src/content/docs/workers/testing/miniflare/writing-tests.mdx
  • src/content/docs/workers/testing/vitest-integration/configuration.mdx
  • src/content/docs/workers/testing/vitest-integration/index.mdx
  • src/content/docs/workers/testing/vitest-integration/known-issues.mdx
  • src/content/docs/workers/testing/vitest-integration/recipes.mdx

Added Files

  • src/content/docs/workers/testing/unstable_startworker.mdx

Renamed Files

  • src/content/docs/workers/testing/vitest-integration/migration-guides/index.mdx
  • src/content/docs/workers/testing/vitest-integration/migration-guides/migrate-from-miniflare-2.mdx
  • src/content/docs/workers/testing/vitest-integration/migration-guides/migrate-from-unstable-dev.mdx
  • src/content/docs/workers/testing/vitest-integration/write-your-first-test.mdx

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 hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

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 hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 9, 2025

Preview URL: https://dadd35a5.preview.developers.cloudflare.com
Preview Branch URL: https://emily-vitest-restructure.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/testing/vitest-integration/configuration/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/vitest-integration/configuration/
https://developers.cloudflare.com/workers/testing/integration-testing/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/integration-testing/
https://developers.cloudflare.com/workers/testing/unstable_startworker/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/unstable_startworker/
https://developers.cloudflare.com/workers/testing/unit-testing/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/unit-testing/
https://developers.cloudflare.com/workers/testing/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/
https://developers.cloudflare.com/workers/testing/vitest-integration/migration-guides/migrate-from-unstable-dev/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/vitest-integration/migration-guides/migrate-from-unstable-dev/
https://developers.cloudflare.com/workers/testing/miniflare/writing-tests/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/miniflare/writing-tests/
https://developers.cloudflare.com/workers/testing/vitest-integration/write-your-first-test/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/vitest-integration/write-your-first-test/
https://developers.cloudflare.com/workers/testing/miniflare/core/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/miniflare/core/
https://developers.cloudflare.com/workers/testing/miniflare/developing/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/miniflare/developing/
https://developers.cloudflare.com/workers/testing/vitest-integration/migration-guides/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/vitest-integration/migration-guides/
https://developers.cloudflare.com/workers/testing/vitest-integration/recipes/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/vitest-integration/recipes/
https://developers.cloudflare.com/workers/testing/miniflare/storage/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/miniflare/storage/
https://developers.cloudflare.com/workers/testing/miniflare/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/miniflare/
https://developers.cloudflare.com/workers/testing/vitest-integration/ https://emily-vitest-restructure.preview.developers.cloudflare.com/workers/testing/vitest-integration/

Copy link
Contributor

@ToriLindsay ToriLindsay left a comment

Choose a reason for hiding this comment

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

@emily-shen Left some suggestions and approved. Also, I noticed that with the new pages, in the Miniflare section, the "Get started" page is now lower in the list. Normally, it would be right under the "Overview". I didn't want to make that change in case it would conflict with any changes you're working on, so feel free to update it on your end or let me know if you want me to fix it after you merge.
Screenshot 2025-04-10 at 12 26 11 PM

@emily-shen
Copy link
Contributor Author

@ToriLindsay fixed the order here 06c6f67 :)

@github-actions github-actions bot added the product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. label Apr 10, 2025
@emily-shen emily-shen merged commit 8af3536 into production Apr 10, 2025
11 checks passed
@emily-shen emily-shen deleted the emily/vitest-restructure branch April 10, 2025 14:17
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* flatten

* change integration-testing.mdx to unstable startworker

* redirects

* fixup

* remove duplicated redirect

* pr feedback

* fix links

* capitalisation

* more invalid links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. product:workers Related to Workers product size/l

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants