Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation 2.0

See original GitHub issue


Suggest to consider implementing a more profound documentation.


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


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


  • 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?)

Issue Analytics

  • State:open
  • Created 5 years ago
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

johnpreedcommented, Mar 19, 2019

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.

kettanaitocommented, Mar 19, 2019

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Documentation (2.0) — OpenSync
Description, Document. Release Notes, RDK-B Integration Release Notes. Integration of OpenSync with RDK-B, RDK-B_OpenSync_Integration.pdf.
Read more >
OpenAPI Specification - Version 2.0 - Swagger
Version 2.0 specification defines a set of files required to describe an API. These files can then be used by the Swagger-UI project...
Read more >
Welcome to Flask — Flask Documentation (2.2.x)
This section of the documentation explains the different parts of the Flask framework and how they can be used, customized, and extended. Beyond...
Read more >
Overview - Spark 2.0.0 Documentation - Apache Spark
This documentation is for Spark version 2.0.0-preview. Spark uses Hadoop's client libraries for HDFS and YARN. Downloads are pre-packaged for a handful of ......
Read more >
Migration guide: Reference docs 2.0 - Redocly
Reference docs 2.0 is a major release that brings many new features and usability improvements, plus a complete visual overhaul of your API ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found