Skip to content

Where should docs live? #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
afontcu opened this issue Jun 1, 2019 · 5 comments · Fixed by #35
Closed

Where should docs live? #33

afontcu opened this issue Jun 1, 2019 · 5 comments · Fixed by #35

Comments

@afontcu
Copy link
Member

afontcu commented Jun 1, 2019

Hi! So, right now, there are two similar (but no exactly equal) versions of Vue Testing Library docs: in the README of this repo, and also in https://testing-library.com/vue.

Kent suggested here to keep the docs in the official website, and just point there from the repository README. How would you feel about that? Having a website seems more useful, as the docs could have several pages (intro, examples, setup, etc as other libraries) instead of having a single file.

I'll happily submit a PR for the README if you think that's the right approach!

@dfcook
Copy link
Collaborator

dfcook commented Jun 1, 2019

Wholeheartedly agree with Kent's suggestion. It would also need a PR against the docs to update the instructions now we've moved to scoped packages (+ maybe an example for cleanup-after-each?)

@afontcu
Copy link
Member Author

afontcu commented Jun 1, 2019

Great! (Official docs have already been updated to fix the naming 😄 Source)

So I'll submit a PR to remove docs from README and point readers to the official site.

I've seen that React Testing Library, ReasonReact, and Native all have like sections with several pages:

imatge

Wouldn't it be cool to have a similar structure for Vue?

@dfcook
Copy link
Collaborator

dfcook commented Jun 1, 2019

It would, happy for you to create this if you have the inclination

@afontcu
Copy link
Member Author

afontcu commented Jun 1, 2019

Sure! I'll first update this repo README so we can close this up, and then think about a simple structure for docs in the official docs repo :)

@alexkrolick
Copy link

Please do! The other wrapper libs are a great starting point for structure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants