Documentation needs improvement

[shvelo]

Feature Request

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

I find the documentation very weird because it mentions decorators / classes / interfaces etc by name and doesn't link to their documentation. The only way to see proper documentation is to see the source comments from the code editor.

Describe the solution you'd like

There should be an API documentation, even if it's auto-generated, preferably versioned, like other projects have, and the regular documentation should link to it when mentioning individual components.

Teachability, Documentation, Adoption, Migration Strategy

For example, in this documentation segment, the @Controller() should be a link to API documentation page for this decorator.

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

This will massively improve the documentation and learning experience.

[kamilmysliwiec]

We're tracking this here nestjs/docs.nestjs.com#413