testing-library / testing-library-docs

docs site for @testing-library/*
https://testing-library.com
MIT License
455 stars 709 forks source link

Do we need to include whole setup guides within our docs? #1302

Closed timdeschryver closed 10 months ago

timdeschryver commented 1 year ago

Some setup pages have a guide on how to install a Testing Library library with a specific test runner (e.g. jest, vitest).

This applies to react (https://testing-library.com/docs/react-testing-library/setup/), marko (https://testing-library.com/docs/marko-testing-library/setup/), and svelte (https://testing-library.com/docs/svelte-testing-library/setup/).

My question is if these pages provide enough value to be added to our docs.

Pros:

Cons:

Alternatives:

MatanBobi commented 1 year ago

Thanks for opening this Tim. I'm pro removing those parts from our documentation following the cons you've posted here :) I agree that documenting the Gotcha's can be nice.

alexkrolick commented 1 year ago

I feel like documenting a known-working setup for the most popular test runners reduces support questions due to people setting up the libraries in unusual ways

timdeschryver commented 10 months ago

Closing this for now. I agree that having a setup guide can be helpful and reduces support questions. Thanks for the feedback!