-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Create documentation of the whole package. We will be using MkDocs for this: https://www.mkdocs.org/
The sections so far to be added are:
- Home
- Includes a brief description of the package
- Includes a brief description about Omndena and the challenge (why this package was created)
- Includes how to refer to this package
- Includes a brief description about the authors (optional)
- Getting started
- Includes how to install
- Includes a basic use case (like the Keras in 30 seconds section)
- Includes any extra detail on how to get started
- User Guide
- Includes detailed descriptions of processes
- Includes documentation of all package (functions and classes)
- Examples section
- Contribution
- Includes contributing specifications
- License
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request