testing-library/testing-library-docs

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

timdeschryver opened this issue · 3 comments

timdeschryver commented

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:

  • easier to get started if you're new (if the docs are up-to-date, otherwise it can be counter productive)

Cons:

  • with the evolving testing landscape we need to keep these pages up to date
  • a strength of testing library is that it's test runner agnostic, so either we should document all runners or none?

Alternatives:

  • Only document the gotcha's / tips and tricks
MatanBobi commented

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

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

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

  • 👍1