docs: Rewrite guides

[brandonroberts]

General

• Architecture

@ngrx/store

• Overview
• Actions
• Reducers
• Selectors
• Testing

@ngrx/effects

• Overview
• Effects
• Testing

Other information:

Tracking these under a single issue rather than separate issues for each one.

[damienwebdev]

@brandonroberts do you need help with this one? We're refactoring our tests over in graycoreio/daffodil and one of our packages depends heavily on ngrx/store. I'd imagine with the new MockStore, you need docs covering this new feature and it's usage.

I'd be happy to chip in here if that would be useful.

[brandonroberts]

@damienwebdev Yes, that would be great!

[simonh1000]

Could I suggest that you add an installation guide for the library as a whole, with schematics etc. I'm relying upon stuff on the internet but never know whether that is best practise

[nasreddineskandrani]

Hi,
I'll open one or multiple PR(s) to update the example-app with MockStore as stated in these comments
#1027 (comment)
I start working on it tomorow.

---

@brandonroberts
You said in this comment #1027 (comment)

All the test documentation will be updated to use the testing module. The testing guide will be updated with better documentation on testing.

MockStore can be used with the tests of effects and also the tests of components....
For this reason, should we separate the doc of MockStore from store, effects testing documentation to don't have to repeat things ...?

I think giving more details about how you see it exactly can help @damienwebdev to add the documentation.

[michahell]

To make sure that my request (making sure there is a part about completing and erroring out killing the observable, effectively) is not forgotten:
#1364

See also explanation in this article:
https://blog.angularindepth.com/5-tips-to-improve-user-experience-of-your-angular-app-with-ngrx-6e849ca99529

[brandonroberts]

Thanks @michahell. There is a specific section in the effects guide that covers this https://ngrx.io/guide/effects#handling-errors

[michahell]

ah, nice, I see :) okay moot point then!

[sgronblo]

Any plan to document State as part of this?

[brandonroberts]

@sgronblo what do you mean? Document the API?

[sgronblo]

Hmm, I must have not been looking close enough yesterday. I was able to find State now. At least in the API section. There doesn't seem to be any mention about it in the "normal" documentation pages on ngrx.io though.

[timdeschryver]

Do you mean this page @sgronblo ? If so, which part?

[sgronblo]

Not sure if this documentation feedback should go somewhere else, but here goes.

I was writing a service that needed to get a value from the Store. Realized that Store is an Observable and got worried that this could cause a problem where my service would not be able to get the required value from the Store until that value changes the next time. Lots of frantic googling finds a mix of different clues that ngrx also contains State which seems like it is same as Store except as a BehaviorSubject.

However, going to the actual ngrx.io site and trying to get a confirmation that my understanding is correct yields almost no information that State even exists. At least not in a way where it is easily found from the left menu on the document page. Eventually I found that State is in the API section here: https://ngrx.io/api/store/State but this page basically doesn't explain anything about whether there are any caveats to using it or whether I can just swap out the Store dependency to a State dependency and have everything work as expected.