epic: documentation about test-utils HOT 6 CLOSED

I'm up for it! I'll start tweaking the docs repo, trying to match the official docs.

So I was thinking of this "Cookbook" section, from simple to not-so-simple examples, where we can set the right mindset when testing common scenarios. It could be community-driven, so we could ask for additional examples. I guess it matches your 2. Guide for common use cases section.

Also, a FAQ section could help – not that people read them often, but it might come in handy to easily link to them in issues and discord. Faster than typing the same answers over and over again 😇

from test-utils.

Closing this in favor of tracking docs here: https://github.com/vuejs/vue-test-utils-next-docs

from test-utils.

So this just came to my mind... could we even "mimic" the official docs table of contents?

From vue-docs-next preview. Hardly the final table of contents, but you get the idea.

Would that make sense? I guess we should ask the docs team why they set up things like that, and try to see if that would help our users too.

from test-utils.

I think the reason they introduce watchers first is they want to teach the users about reactivity in Vue, which means computed properties and watchers.

Something like this could work, interested to see what you come up with - happy to review anything. What kind of content do you think is essential for the introduction section? Are we writing code, or just talking about VTU?

Cookbook also sounds good.

from test-utils.

I'm gonna give the "official docs table of contents" idea a go, so we can see what it looks like. Come back to you with a PR soon.

from test-utils.

Sounds good! Looking forward 🙇 I'm guessing we can get some feedback from the docs team too.

from test-utils.