Skip to content

Split existing tutorials up into documentation on different levels #71

@apirogov

Description

@apirogov

Currently, the Notebooks are in the uncanny valley between various kinds of documentation, while being not fully satisfactory on any single "level".

They should be broken apart and cross-linked.

There should be:

  • concepts (high abstraction level)
  • tutorial, bite-sized examples (concrete, copy-paste-able)
  • mid-level manual (explanation beyond what is in the docstrings)
  • automatic docs (the technical reference, generated from docstrings)
  • pure user docs (for users not writing code)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions