-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
docs: reorganize installation instructions into individual pages for each module #1523
Conversation
Preview docs changes for b487127 at https://previews.ngrx.io/pr1523-b487127/ |
Just realized I missed some of the other |
What do you think about having a dedicated "Installation" page for each library? It would have the normal npm/yarn instructions, and have the instructions on using ng-add and what it does. I want to keep the overview pages pretty light. |
@wesleygrimes I was just typing the same thing but in another way. |
@brandonroberts @timdeschryver I'm good with either way... I personally like the idea of an Installation link under each main section like Store > Installation, Store Devtools > Installation. And then I will move what is in Getting started there for each and add the ng add commands there as well. |
@brandonroberts @timdeschryver ok, I almost have it, one question, do you want the getting started pages to still have a link to the installation pages or do you just want them to find it by clicking the navigation links? |
I think a link to the page is good. |
@brandonroberts @timdeschryver ok updates have been posted, also renamed the PR to reflect more of what is included. |
Preview docs changes for 9b3d048 at https://previews.ngrx.io/pr1523-9b3d048/ |
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 👍 !
Would you also want to include the rest of the ng add
commands?
… include documentation for optional ng add flags
@timdeschryver @brandonroberts I have pushed a final commit that includes the |
Preview docs changes for 67c1238 at https://previews.ngrx.io/pr1523-67c1238/ |
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.
Minor fixes with extra semicolons and typo
Prefix commits with Looks great! |
Thanks! I’ll get these resolved in the morning! Have a great evening. |
Preview docs changes for 6bd14b8 at https://previews.ngrx.io/pr1523-6bd14b8/ |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Missing documentation on use of
ng add
What is the new behavior?
Added a new section to the https://ngrx.io/guide/store that documents how to use the
ng add
commands for NgRx.Does this PR introduce a breaking change?
Other information
Cross-reference #1146