Documentation 2.0

[kettanaito]

What

Suggest to consider implementing a more profound documentation.

Why

1. Better developer experience.
2. Better newcomers guidance.
3. Better overall improvement from the solution.

How

1. Research on service solutions.
2. Potentially develop a small doc app.
3. Live code examples are very anticipated.

Roadmap

• Review the entire documentation for inconsistency, confusing and lengthy explanations
• Add explanation of valid/invalid separation
• Provide use cases for createField custom options. Explain options more effectively, eliminate confusion. Grant a clear picture what are those options for, and what they are not.
• Change "Field group" example in README to demonstrate all possibilities of field groups (split groups, nesting)
• Include comparison section between different form solutions (redux-form, formik, you-name-it?)

[kettanaito]

As one of the readers has pointed out, it's nice to illustrate some benefits of the validation based on pure resolvers. It can cover even complex scenarios quite easily. Perhaps, having a list of various validation examples (only schemas) would be nice to have.

[kettanaito]

I must say that the updated Gitbook looks very promising. If I be able to integrate a live examples there, then the place for Docs 2.0 is defined.

[kettanaito]

Need to consider to add the comparison section to the README page.

Comparison illustrate the same scenarios achieved using different form libraries. It will help people to understand the differences.

Possible scenarios

1. Simple form.
2. Nested form.
3. Async validation.

[johnpreed]

What I find lacking is documentation on how to use field options like mapPropsToField, enforceProps, mapping/setting initial values of components, beforeRegister, shouldUpdateRecord. Detailed explanations of these along with examples would go a long way.

[kettanaito]

You are completely right, @johnpreed. I will try to take the original requirements why those methods were implemented, and put them in a form of examples.

Update: Please take a look at the updated createField Options. Let me know if it's more clear now. Thanks.