Skip to content

docs: update guide sidebar, add more recipes#10226

Merged
sheremet-va merged 3 commits into
vitest-dev:mainfrom
sheremet-va:docs/add-recipes-update-sidebar
May 18, 2026
Merged

docs: update guide sidebar, add more recipes#10226
sheremet-va merged 3 commits into
vitest-dev:mainfrom
sheremet-va:docs/add-recipes-update-sidebar

Conversation

@sheremet-va

Copy link
Copy Markdown
Member

Over time I am noticing it is hard for users to discover new features that we release. They usually get buried in blog or mentioned off-hand in the api/guide section.

This PR tries to change that by adding new recipes for the features that we added in the last several majors. The content was initially generated by claude, then re-prompted and reviewed by me

Additionally, I restructured the "Guides" sidebar because it became hard to distinguish between entries, it became a huge list of articles. Hopefully grouping them distinguishes them more

@netlify

netlify Bot commented Apr 28, 2026

Copy link
Copy Markdown

Deploy Preview for vitest-dev ready!

Name Link
🔨 Latest commit 6ef1422
🔍 Latest deploy log https://app.netlify.com/projects/vitest-dev/deploys/69fcbb848edd24000868f229
😎 Deploy Preview https://deploy-preview-10226--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@hi-ogawa hi-ogawa left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm

Comment thread docs/guide/recipes/domain-locators.md Outdated
Comment thread docs/guide/recipes/cancellable.md

@AriPerkkio AriPerkkio left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we should have a "landing page" on the Guides tab. It should describe what sections there are on the sidebar. It would be duplicate content, but it would be more verbose than the actual sidebar. Right now we are expecting users to check sidebar for all sections when they land on guides.

Comment on lines +5 to +9
# Parallel and Sequential Test Files

Most test files are independent and run faster in parallel. The exception is the handful that share an exclusive resource, like a fixed port, a writable temp directory, or a database without per-test isolation. Those files flake when other tests run concurrently with them.

Disabling parallelism globally would slow down every test in the suite. Splitting the suite into two [`projects`](/guide/projects), one parallel and one sequential, lets only the affected files pay the cost.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Would be nice to have an illustration picture here showing what parallel and sequential means.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'm gonna merge this and add a comment to create a follow up to have this image, otherwise we will never merge this 😭

@hi-ogawa

Copy link
Copy Markdown
Collaborator

Astro's recipes look like this also with landing page https://docs.astro.build/en/recipes/

Comment thread docs/guide/recipes/wait-for.md
Comment thread docs/guide/recipes/domain-locators.md Outdated
Comment thread docs/guide/recipes/disable-isolation.md Outdated
Comment thread docs/guide/recipes/parallel-sequential.md Outdated

@AriPerkkio AriPerkkio left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Overall looks good! Recipes are great 💯

@sheremet-va
sheremet-va merged commit 54ad2f5 into vitest-dev:main May 18, 2026
11 checks passed
@sheremet-va
sheremet-va deleted the docs/add-recipes-update-sidebar branch May 18, 2026 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants