Cleanup the Readme and setup docs website with Docusaurus

[thymikee]

There's a lot of information in the Readme right now. We should move the API and examples into separate files and then maybe generate a website out of it with Docusaurus.

[thymikee]

Would also be cool to mention Rally.
cc @FLGMwt, feel free to send a PR with a wording of your preference :)

[brooksbecton]

Docusaurus creates a new website with it's own package.json
Here is an example of the structure: https://docusaurus.io/docs/en/installation#verifying-installation

Are ya'll wanting to keep this Docusaurus site within this repo or have a seperate repo for the doc site?

I was just going move stuff into a "docs/" folder, but having 2 package.jsons seemed weird to me.

Any thoughts on where to put this site?

[thymikee]

Thanks for offering help!
I'm cool with this sitting in docs/ directory, no need to sync between repos.
cc @Esemesek as he started to work on this but didn't have time to finish.

[thymikee]

FYI @brooksbecton #70 brings docs/api.md to the table. So adding Docusaurus should be easier once that's merged.

[brooksbecton]

I have the basic website going on this branch: https://github.com/brooksbecton/react-native-testing-library/tree/Add_Docusaurus_Website

I think there will just be a lot of tweaking now as far as colors, logos, front page content, and layout stuff.

To check it out:

• Go to docs/website
• npm i
• npm start

[thymikee]

Awesome! Can you send a PR btw?

[thymikee]

#74 by @brooksbecton is merged, which means we have a website set up (but not running yet)! Now we need to polish it a bit, add nice icons, and publish. Anybody interested in doing so? 😃

[dcalhoun]

@thymikee do you have a specific list of tasks you'd like to accomplish? If so, I'll try to find some time to contribute. I would love to see a docs site up sooner rather than later, regardless of what it looks like. 😆

[thymikee]

The website is started and lives under website/ directory. We need to:

• clean it up from Docusaurus defaults
• set up a CI task for publishing docs to gh-pages

After we have docs set up and deployed to gh-pages branch, I'm planning to write a series of common examples for "how to write test for this use case".

I'd greatly appreciate help on the mentioned topics :)