docs.nestjs.com icon indicating copy to clipboard operation
docs.nestjs.com copied to clipboard

[Documentation] Show 3rd party libs with compatible version

Open bitbreakr opened this issue 3 years ago • 1 comments

Is there an existing issue that is already proposing this?

  • [X] I have searched the existing issues

Is your feature request related to a problem? Please describe it

Some companies have difficulty updating to more recent versions because of technical debt.

I have broken the production environment, installing the latest NATS with @nestjs/microservices version 7.5.5, and still don't know which version works with the other.

Describe the solution you'd like

Using @nestjs/microservice with nats, for example, is not problem-free.

For all versions of the documentation, each time a command is displayed to install a dependency that depends on a 3rd party, a select should ask for the exact version of Nest.js and then display the command with the exact version to install

The documentation should, for security measures, show which version of microservice is compatible with which version of clients like Redis, nats, rabbitmq, etc...

Teachability, documentation, adoption, migration strategy

Here below is an example of a switcher (1) and the command to install a package (2)

When the user selects a specific version of Nestjs (1), the command shows the according version of a 3rd party package that will work flawlessly with the microservice package (2)

CleanShot 2022-11-07 at 11 20 24@2x

What is the motivation / use case for changing the behavior?

My motivation is to prevent other developers from having the same issue as Nestjs is a project that evolves fast.

bitbreakr avatar Nov 07 '22 10:11 bitbreakr

yeah, that would help a lot

My only concern is that others snippets and the text itself in the page won't change accordingly, and this might confuse people.

micalevisk avatar Nov 07 '22 13:11 micalevisk