Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement a comprehensive documentation #6

Open
lweberk opened this issue Mar 5, 2017 · 2 comments
Open

Implement a comprehensive documentation #6

lweberk opened this issue Mar 5, 2017 · 2 comments

Comments

@lweberk
Copy link

lweberk commented Mar 5, 2017

No description provided.

@lweberk
Copy link
Author

lweberk commented Mar 5, 2017 •
edited
Loading

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
Copy link
Author

lweberk commented Mar 6, 2017

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lweberk