docs(material): examples in jsdocs

Feature Description

Currently the jsdocs on components is very minimal, with very little detail

https://github.com/angular/components/blob/39921f43382e3abc90c14fd8602d0cf371239fce/src/material/button/button.ts#L62-L64

Example how how this displays in VS Code

With material-experiential things seem greatly improved https://github.com/angular/components/blob/39921f43382e3abc90c14fd8602d0cf371239fce/src/material-experimental/mdc-button/button.ts#L30-L38

But I think there is still a few things missing. There is a link to the material design docs which is great, but it would be awesome to have a link to the Angular Material documentation which has code examples and live demos.

Additionally it would be cool to have code examples in the JSDocs themselves. This helps with discoverability of different ways of using components, for example showing the mat-flat-button as an example would be quite useful on the mat-button JSDoc

Use Case

Having faster access to documentation will not only help new developers who are not familiar with all the APIs that @angular/material has to offer, but also help refresh the memory of any developers who works in many context, such as backend work.

[wagnermaciel]

@bonganiSibiya All yours. Nobody has started this issue yet

[angular-robot[bot]]

Thank you for submitting your feature request! Looks like during the polling process it didn’t collect a sufficient number of votes to move to the next stage.

We want to keep Angular rich and ergonomic and at the same time be mindful about its scope and learning journey. If you think your request could live outside Angular’s scope, we’d encourage you to collaborate with the community on publishing it as an open source package.

You can find more details about the feature request process in our documentation.