Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Description
Feature Description
Currently the jsdocs on components is very minimal, with very little detail
components/src/material/button/button.ts
Lines 62 to 64 in 39921f4
Example how how this displays in VS Code
With material-experiential things seem greatly improved
components/src/material-experimental/mdc-button/button.ts
Lines 30 to 38 in 39921f4
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.
Activity