React-testing-library: Do you think to make a website for documentation?

Created on 9 Aug 2018  路  29Comments  路  Source: testing-library/react-testing-library

documentation help wanted

Most helpful comment

What do you think guys? Sincerity, please!

home

All 29 comments

I've definitely thought about it! I think I would like to if I get some time. Would you like to do it?

Yes, I like. Could we use Gatsby for this task?
Is the content the same those on Github?

Gatsby would be perfect! I think I'd like to have a single website to host all of the *-testing-library (see the defendants tab on dom-testing-library) documentation because it'll all be so similar/shared information. What do you think?

I liked this idea, but I didn't understand well what is "defendants tab".
Could you organize the content of site on a repository?
Do the project has an official logo?

Sorry, I meant "dependants tab"

screen shot 2018-08-10 at 10 00 27 am

Not all of those need to be documented with dom-testing-library, but these definitely could:

  • cypress-testing-library
  • react-testing-library

And we could invite the authors of these libraries to contribute docs for their libraries to the site as well:

  • pptr-testing-library
  • bs-dom-testing-library
  • vue-testing-library
  • preact-testing-library
  • ng-testing-library
  • ngx-testing-library

I _think_ that I'd really like the docs written in mdx with https://github.com/ChristopherBiscardi/gatsby-plugin-mdx

There's no official logo. If you could get things started with the site, then I can start contributing content for the docs :) Let's go ahead and start with having the site be part of this repo. You can put it in a website directory with its own package.json. We can move it to its own repo later :)

Thanks!

Ok, Kent. I will try to begin the project as soon as possible.

@kentcdodds That sounds a great idea. I have authored preact-testing-library (you knew it ;)) and I can work on the documentation part for the same!

What do you think guys? Sincerity, please!

home

This is such a fantastic start! Keep going and posting screenshots/demos. I'll give more feedback when I can.

I need ideas for other sections

The most important part is the docs page, so maybe get started on the API reference?

Looks good btw 馃槂

Nice job!

@kentcdodds What you think about add more three sections after "Some advantages" section: 1. Video overview, 2. Contributors or Sponsors, and 3.Who's using the library?

Yes, all three of those would be cool :+1:

looking great!

@glauberfc any progress on this or ways I can get involved with documentation site. Big supporter of these projects and want to help out if I can.

I'm sorry guys. I needed to travel and ended up don't finishing the layout. I will finish asap, so we can discuss how we can implement and grow it. Thanks for help @Lukeghenco

What you think guys? Sorry by the typos.
I think that we can improve de design during the development

home

I think it's a great start! We can start here and iterate from there :)

Would love to get involved - think this is a great library and would like to help promote it!

May I init the project with Gatsby?

I've been thinking about how I want to do this... This site will be used to document all of the *-testing-library projects that want to take part. So I think it would be best to be in its own repo. Perhaps eventually I'll make a GitHub org for repos such as this, but I don't want to do that at the moment. For now, why don't you just create the repo under your own user @glauberfc? Then we can move it later if we decide to.

Ok, @kentcdodds, I'll do. When you make the repo I going to move the files to it.

When you make the repo I going to move the files to it.

Sorry, to be clear I was saying that _you_ can make the repo :) Just link to it here and I'll start following progress there :)

Sorry! I meaning that if some day you make a Github org repo I going to transfer the files to it.

@kentcdodds do you have some tip or article link about how use Styled Components in an organized way or showing "the right way" of use it?

I want organize the styles as better as possible on the project.

Sorry, I don't. I personally prefer emotion though I don't have such an article either.

Hey! Thank you for this awesome library. If you need a helping hand than I would like to support you.
Keep up the good work!

Sweet, here's the repo: https://github.com/glauberfc/dom-testing-library-website

I'm watching that repo. I'm going to go ahead and close this issue and we can continue discussion over there. Thanks!

Was this page helpful?
0 / 5 - 0 ratings