What is people's opinion about using GitBook to capture comprehensive documentation for Coin components?
Here is the link to this resource: https://www.gitbook.com/solutions/open-source.
While working on the X3D Coin implementation, I am updating the internal API documentation to reference the specification (similar to what was done for VRML code base). There will be a lot of documentation generated through this approach. But I realize that there is a lot of information that can be captured on usage and examples. So, I thought that Gitbook could be used as a "User Manual".
Coin documentation could be broken down into the following categories:
- API Documentation (generated like now, published to project web page)
- Source for docs is in code base
- Github Wiki (informal documentation for development)
- GitBook Documentation
- Examples and Tutorial documentation
- Integrated with API documentation
- Published to project web page
- Source for documentation is in new Github repo
What is people's opinion about using GitBook to capture comprehensive documentation for Coin components?
Here is the link to this resource: https://www.gitbook.com/solutions/open-source.
While working on the X3D Coin implementation, I am updating the internal API documentation to reference the specification (similar to what was done for VRML code base). There will be a lot of documentation generated through this approach. But I realize that there is a lot of information that can be captured on usage and examples. So, I thought that Gitbook could be used as a "User Manual".
Coin documentation could be broken down into the following categories: