Skip to content

Conversation

@emily-shen
Copy link
Contributor

@emily-shen emily-shen commented Apr 7, 2025

Summary

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.

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 7, 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

Updated the Vitest getting started guide to enhance clarity and usability for users testing Workers.

  • Revised the introduction to emphasize the benefits of using the Workers Vitest integration.
  • Updated links and button texts for better navigation and clarity.
  • Improved the testing comparison matrix for better readability and understanding.
  • Clarified prerequisites and installation steps for the Vitest integration.

Modified Files

  • src/content/docs/workers/testing/index.mdx
  • src/content/docs/workers/testing/vitest-integration/get-started/index.mdx
  • src/content/docs/workers/testing/vitest-integration/get-started/write-your-first-test.mdx
  • src/content/docs/workers/testing/vitest-integration/index.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 github-actions bot added size/m product:workers Related to Workers product labels Apr 7, 2025
Copy link
Member

@edmundhung edmundhung left a comment

Choose a reason for hiding this comment

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

Love the improvements! Just a few minor nitpicks, but nothing's blocking. 👍🏼

sidebar:
order: 1
group:
hideIndex: true
Copy link
Member

Choose a reason for hiding this comment

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

Looks like most of this pages is moved to the overview of the vitest-integration. Should we redirect people to the overview page instead of keeping a duplicate here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i think you need an index.mdx at every level, so we can't get rid of it entirely, just hide it like this. Would love to though if you know how!

I also plan to move some pages around so its not so nested, but that PR was getting super confusing to review so i'm going to do content updates here first, then move pages around.

@emily-shen
Copy link
Contributor Author

thanks for the spot on feedback @edmundhung 🎉

@emily-shen emily-shen force-pushed the emily/vitest-get-started branch from d1ebe76 to 6b721d8 Compare April 8, 2025 10:29
@emily-shen emily-shen enabled auto-merge (squash) April 8, 2025 10:29
@emily-shen emily-shen merged commit 59a10ce into production Apr 8, 2025
11 checks passed
@emily-shen emily-shen deleted the emily/vitest-get-started branch April 8, 2025 10:40
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* update write your first test

* tidy up various overviews

* pr feedback
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.

8 participants