Rewrite Getting Started Guide
See original GitHub issueDocumentation Feedback
I think that we should do more in our docs to highlight the happy path that is ng add @angular/material
and the prompts / options we offer. Currently, we mention it only as a sub-bullet alternative (https://material.angular.io/guide/getting-started#alternative-2-angular-devkit-6-) and then continue on with telling the developer how to manually configure everything.
We cover ng add
a bit better in https://material.angular.io/guide/schematics#install-schematics, but a new user is going to look at the “Getting Started Guide” first.
This was also reported in https://github.com/angular/components/issues/14380.
How would we want to solve this?
- Linking from Getting Started to the Schematics Guide?
- Or totally re-writing the Getting Started Guide to highlight
ng add
and move the manual config to alternative steps at the end?
Affected documentation page: https://material.angular.io/guide/getting-started
Jeremy mentioned that @manughub has already started working on this but that there was no issue to track it.
Issue Analytics
- State:
- Created 4 years ago
- Comments:6 (5 by maintainers)
Top GitHub Comments
Yes that’s fine.
I have the PR ready to go for getting started with Material and it will be out for review shortly.
-Manu
On Mon, Jul 29, 2019 at 6:14 PM Michael Prentice notifications@github.com wrote:
Update: I’ve rewritten the getting started guide and reviewed with @jelbourn. Working on the PR and expect to have it out for review this week.