cppstddb icon indicating copy to clipboard operation
cppstddb copied to clipboard

Published 20 hours ago • verified publisher icon cruisercoder

Implement a comprehensive documentation

Open lweberk opened this issue 7 years ago • 2 comments

lweberk avatar Mar 05 '17 21:03 lweberk

Left description open to leave room for debate on how and with what tools.

Maybe using sphinx hosted on readthedocs? Idea is not to have a API-only doxygen generated documentation, but a walk through and rationale description of the library and its applications. Quite frankly lacking currently in the database libraries space in C++. I was thinking something more like the sqlalchemy documentation. But beware of my slight bias towards the python ways on this one.

Documentation should reflect the "standardized interface". With 2 sections aimed separately to driver developers and application developers.

As initial source of information; talk. Is there anything written or any access to the slides?

lweberk avatar Mar 05 '17 21:03 lweberk

Slides can be found as a PDF in the official cppcon material repository.

lweberk avatar Mar 06 '17 00:03 lweberk