Add docs to testing-library-docs

[mpeyper]

There is an existing PR created to add docs to testing-library-docs from when testHook was part of react-testing-library. Since it was removed and the code merged with this library, the PR has stalled waiting on updates to change it to reference this library instead.

If anyone wants to take over the PR and update it accordingly, you are more than welcome. You can even add yourself as a contributor here for your effort too.

See the PR for more details.

Disclaimer: I am not affiliated with the testing-library-docs repo or the PR in question, but I was asked to take it over and just find myself a bit time poor to actually do so at the moment.

[ab18556]

@mpeyper could you point me out exactly what needs to be done? I might be interested to do it.

[DavidBabel]

Hey guys, thanks for your lib, it looks promising. But it will be interesting if you can provide more examples in the doc. Especially on the rerender part, which is not very clear for me at this point.

[mpeyper]

@ab18556 It was suggested that it would be useful to add some documentation in the ecosystem section of https://testing-library.com/docs/intro.

Some work was previously done when the API was part of react-testing-library, but it would need to be updated to reference react-hooks-testing-library instead of react-testing-library and moved into the other section now.

The API is also slightly different now to when the PR was created the main differences from the top of my head:

• testHook -> renderHook
• initialProps and rerender(newProps)
• waitForNextUpdate()

It probably doesn't need to be too over the top with information, just the basics and a link back to our own docs (which also need to be improved).

[ab18556]

Ok I will give it a try tomorrow night

[mpeyper]

Great! I've also raised #19 now which is also around docs (but our own) if your keen for that as well?

[ab18556]

Sorry, I won't be able to update the doc. I am short on time and since english is my secondary language, I don't think I would be the best person to do it.

About the current issue, I made this PR testing-library/testing-library-docs#64

It is based on the current doc's example. It might have to be updated once the doc is updated.

[alexkrolick]

Thanks for the PR @ab18556, it's a good start. I think at least establishing an ecosystem page like this one would be enough to merge: https://github.com/alexkrolick/testing-library-docs/blob/master/docs/ecosystem-user-event.md

[ab18556]

@alexkrolick this is basically what I put into the example page. Maybe it shouldn't be in the example section?

[alexkrolick]

Ok, moving it all into the ecosystem page sounds good, too.

[ab18556]

@mpeyper Any thoughts?

[mpeyper]

Sorry @ab18556 for not giving my thoughts (this one went under my radar).

I'm going to close this as since #40, we are no longer using react-testing-library for our rendering, so I'm no sure it's appropriate for us to be included in their docs anymore, unless there was some disclaimer added about this.