Lack of documentation

[victor1234]

There is no complete documentation and reference. How to help fix it?

[zauguin]

The current approach of writing everything into the README doesn't really scale. I personally would like using Standardese for the reference documentation. Maybe you or @aminroosta have other suggestions?

If we go down this route and you are into CMake, it would be awesome if you could integrate this into the new build system in the develop branch. Alternatively you could start writing documentation comments for some functions. They don't have to be perfect yet, but it would get the ball rolling.

[DBJDBJ]

This is/was a great effort of a few good people. +1 for that.

The key top-level architectural view is missing. Inevitably, it appears (at least to me) this lib is way overengineered. But looking into the code only, it is impossible to be certain. A proper white paper (a lot of diagrams please, but not from the code) might remedy this.

[Xeverous]

For sure a more detailed doc is needed. Examples don't even fully cover obtaining results or the mapping between SQL return types vs types supported by >>.