8000 📖 More Documentation Besides API Docs · Issue #42 · qbitkit/qbitkit · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
📖 More Documentation Besides API Docs #42
Open
@brianlechthaler

Description

@brianlechthaler

Good documentation is paramount to the success of any open source project, especially for a robust and feature-packed framework like qbitkit. Our API documentation is very extensive to say the least, but this alone is not enough. We want our users to dive right in and adapt to any learning curves qbitkit presents as fast as possible, and asking people to just dig through the API doc to figure out what they need for a project will probably turn people away. There's many other great reasons to have a more well documented qbitkit, but the primary goal of qbitkit is to make things easy, and the only way to ensure we are meeting that goal is to make sure our users have everything they need to build robust applications for the next generation of computation.

Metadata

Metadata

Labels

Best PracticeImprovements to compliance with relevant best practicesDocumentationImprovements or additions to documentationLong-term GoalSomething planned well into the future

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions

    0