-
Notifications
You must be signed in to change notification settings - Fork 150
Open
Labels
docImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
For Datumaro 2.0, we want to substantially improve the quality of the documentation, to make the library more appealing and accessible to new users.
Documentation should be intended in a broad sense, including but not limited to:
- The root
README.md - The docs, currently hosted at https://open-edge-platform.github.io/datumaro
- Docstrings
- Code snippets / notebooks
- Blog posts
The documentation should cover at least these topics:
- Features supported by Datumaro
- Including detailed info about the supported conversion formats and transformations
- Core concepts and architecture
- How to install (library, extras, CLI, ...)
- How to contribute, report bugs and request features
- How to migrate from 1.x to 2.x
- Realistic examples of usage
Metadata
Metadata
Assignees
Labels
docImprovements or additions to documentationImprovements or additions to documentation