-
Notifications
You must be signed in to change notification settings - Fork 6.8k
docs: update information about schematics #11091
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I clarified some information to the best of my knowledge and restructured the doc a bit for better readability.
@@ -6,22 +6,13 @@ Schematics come packaged with Angular Material, so once you have | |||
installed the npm package, they will be available via the Angular CLI. | |||
|
|||
If you run it will automatically install Angular Material for you | |||
and run the shell schematic. | |||
and run the install schematic. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is actually called "shell" in the collection.json
. We should change that, too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"shell" typically means "app shell" which includes navigation similar to the material-nav schematic, but that is not included in the shell/install schematic as far as I know.
if you'd like to change the underlying schematic name, then could someone please take over this PR as I'm not familiar with the implementation details and won't have time to follow up on this PR today.
ng add @angular/material | ||
``` | ||
|
||
## Generator Schematics |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know if "Generator Schematics" is the best term, but all the schematics are "packaged" so it seems like suboptimal name. I'd rather differentiate them by how they are used "install vs generator" than "shell vs packaged". please let me know if you think otherwise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, the names are good now. I can change the name in a follow-up (we don't use the term "shell" for anything else so it won't be hard).
thanks for the review! |
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
I clarified some information to the best of my knowledge and restructured the doc a bit for better readability.