Improving ReSwift Documentation / Examples about reswift HOT 16 OPEN

I think for version 1.0 documentation is hugely important. Especially because many iOS developers have not used Redux or libraries like it before. I plan on using this library for a few internal projects pretty soon so I'll see if I can swing some time to help with the documentation.

from reswift.

Agree! I'm starting some restructuring of the docs on a separate branch: https://github.com/ReSwift/ReSwift/tree/benji/1.0-docs

Along with the recording of the talk and the example app we're building, this should be a good starting point.

@RubenSandwich if you identify areas that are especially unclear it would be awesome if you could share them. Any form of contribution to the docs is also very welcome. I would imagine that something like a small step-by-step tutorial could be very useful, too!

from reswift.

I'll also arise from the dead and contribute to the docs. April is clearing up on my end and I would love to get back into this.

Great work Ben!

from reswift.

Most work is currently done on the Getting Started Guide. You can follow along here: https://github.com/ReSwift/ReSwift/blob/benji/1.0-docs/Docs/Getting%20Started%20Guide.md

Any thoughts so far?

from reswift.

It's looking good. A lot easier to follow with it all in the one guide.

from reswift.

Couple of notes that should probably be included. Mainly for newcomers to highlight gotchas that they may not be obvious at first sight.

State: it's normally good practice to denormalize state objects.

Reducers: need to be fast, avoid making any changes unless a matching action is passed in. E.g. Don't sort and return an array inside a reducer on every invocation. Ideally something like array sorting would be pushed to the Subscribers / ViewModels.

from reswift.

@Ben-G Hi, if u need help with example app, I can help 😄

from reswift.

@TheSooth help would definitely be appreciated! Have you already started working on a project?

from reswift.

@Ben-G nope, before starting I would to discuss with u, what exactly we want to show in example app :)

from reswift.

How about implementing an authentication process? Every app needs it, so it
would be a natural first step to get to know the framework starting with
the example instead of from scratch.

from reswift.

Might I suggest two different example projects, one more of a tutorial example and one more of an actual real world app example. This way someone with no familiarity with with a redux like architecture can look at the tutorial example and then have the foundation to understand the non-trivial example. For the tutorial example I was thinking something in the vein of the Elm Architecture Tutorial; a counter, a list of counters, then a dynamic list of counters and finishing on a network image loader.

from reswift.

I have an example app that you might be able to use: https://github.com/AlexLittlejohn/Weight. It's a weight tracker I made to teach myself the framework. I'm not sure if it follows best practices and so on but I would be willing to clean up/change it however necessary.

from reswift.

Docs is definitely a prio, but hammering home the need for immutability in the Store/Reducers and fleshing out the best practices for async actions (which is really the only tricky part imho) is important as well. I'll see what I can contribute once I start using it a bit more heavily in the next weeks.

from reswift.

I have a quick example of facebook login using reSwift:
https://github.com/vitkon/redux-swift-example

from reswift.

Thanks a lot for sharing your example projects! I was traveling for the last 2 weeks but hopefully this weekend I should find some time to take a look at them and provide feedback.

Really appreciate your participation!

from reswift.

Getting started part needs to be in more detail. It took me some time to figure out how to wire it up.

from reswift.