testing-library-docs icon indicating copy to clipboard operation
testing-library-docs copied to clipboard

Versioned docs

Open levino opened this issue 5 years ago • 3 comments

Is your feature request related to a problem? Please describe. I have a project which uses version 9.4.0 of the react testing-library. I cannot find documentation on the interface of that version. The docs do not even tell me the version they are for... It would be nice if one could also browse the docs for the older versions of the libraries. Describe the solution you'd like Use versioned docs, like NodeJS does https://nodejs.org/dist/latest-v14.x/docs/api/

Describe alternatives you've considered I checked out this repo and am going to build the old docs by hand. Not nice, obviously.

levino avatar Sep 16 '20 14:09 levino

Docusaurus supports versioning, but we haven't added it for a few reasons:

  1. Which package do we track? DOM, React, Cypress?
  2. Maintaining the old versions in-repo the Docusaurus way requires creating sub-directories and moving things around fairly often

To make this a bit easier, and assuming there is an answer for (1), we could create GH releases for one of the packages and link it to a Netlify cached build (every PR gets a preview build).

alexkrolick avatar Sep 16 '20 17:09 alexkrolick

Is this a duplicate of #484?

nickserv avatar Oct 07 '20 13:10 nickserv

Yes, I guess so but think that my issue is more actionable / straighter to the point. Happy to close this in favor of #484 if it makes sense to the others though.

levino avatar Oct 07 '20 14:10 levino

I'm closing this one in favor of #484, let's discuss it there :) Thanks!

MatanBobi avatar Mar 22 '23 07:03 MatanBobi