Wrote an intro tutorial for beginners. #323
Conversation
SethDavenport
force-pushed
the
docs/intro-tutorial.md
branch
from
ab39dbb to
bc6ff17
Compare
|
@rajinder-yadav this was something you mentioned a while back. Thoughts? |
|
Note to self:
|
README.md
Outdated
|
|
||
| Redux is a popular approach to managing state in applications. It emphasises: | ||
|
|
||
| * A single, immutable data store |
There was a problem hiding this comment.
For a proper sentence, it's a good idea to add a period. You can omit it, but stay consistent since the last bullet has a period.
README.md
Outdated
| into your Angular 2+ applications. Our approach helps you by bridging the gap | ||
| with some of Angular's advanced features, including: | ||
|
|
||
| * Change processing with RxJS observables |
There was a problem hiding this comment.
Same comment about add or omitting a period.
| * Compile time optimizations with `NgModule` and Ahead-of-Time compilation | ||
| * Integration with the Angular change detector. | ||
|
|
||
| ## Getting Started |
There was a problem hiding this comment.
What style of heading are you following. Two popular one are:
- Capitalize each word
- Capitalize first word and only "nouns". (See to be preferred for published articles).
I would go over the sub heading to make sure they are consistent.
There was a problem hiding this comment.
Yeah I will stick with English Title Case rules. Thanks.
There was a problem hiding this comment.
Although strictly speaking title case is typically defined in English as capitalizing everything except prepositions, articles, and pronouns :)
| import reduxLogger from 'redux-logger'; | ||
| import { rootReducer } from './reducers'; | ||
|
|
||
| interface IAppState { /* ... */ }; |
There was a problem hiding this comment.
Would be nice to expand on how the interface IAppState comes into play. For single state or multiple states. Later how those states are accessed, if they are separate groups of states.
There was a problem hiding this comment.
Yeah I'll add a note. However I didn't want to get into too complicated an example in this tutorial. I might write a second chapter later.
| }) | ||
| export class AppModule { | ||
| constructor(ngRedux: NgRedux<IAppState>) { | ||
| ngRedux.configureStore(rootReducer, {}, [ createLogger() ]); |
There was a problem hiding this comment.
I found configureStore initially confusing, the API and what each argument signifies. Would be nice to expand and explain it here quickly.
|
Looks goods, just a few comments. |
2 participants
Fixes #314