Skip to content

Rewrite Getting Started Guide #16426

Closed
@Splaktar

Description

@Splaktar

Documentation 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 #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.

Metadata

Metadata

Assignees

Labels

P2The issue is important to a large percentage of users, with a workarounddocsThis issue is related to documentationin progressThis issue is currently in progress

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions