Skip to content

Write extensive documentation #18

@lorenzofelletti

Description

@lorenzofelletti

Proposal

Write extensive documentation of the project, and how to use it, trying to be as complete as possible at explaining the features.

Ideally we should have:

  • Getting started
  • Examples
  • All features and configurable options documented
  • Design doc with images, etc.

Motivation

Having a good documentation is crucial to decrease the steepness of the learning curve for new users.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions