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.

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

Documentation #51

Open
bassoy opened this issue Jul 27, 2018 · 0 comments
Open

Documentation #51

bassoy opened this issue Jul 27, 2018 · 0 comments
Assignees
Labels
discussion Discussion for future refactoring gsoc Google Summer of Code

Comments

@bassoy
Copy link
Collaborator

bassoy commented Jul 27, 2018

I suggest that part of the documentation to be ported to Github.

We can leave the HTML documentation for library designers where the interfaces, member types and member functions are well described. It could be also something different than HTML.

However, I suggest there should be a separate documentation only for library users. This would make it for both groups, especially for the users so much easier to understand and use the library.

@bassoy bassoy added documentation Documentation is required discussion Discussion for future refactoring labels Jul 27, 2018
@bassoy bassoy self-assigned this Jul 27, 2018
@bassoy bassoy added the gsoc Google Summer of Code label Jul 27, 2018
@bassoy bassoy removed the documentation Documentation is required label Jul 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Discussion for future refactoring gsoc Google Summer of Code
Projects
None yet
Development

No branches or pull requests

3 participants