Skip to content

Textual documentation #51

@Sbozzolo

Description

@Sbozzolo

Is it possible to provide the documentation also in plain text or markdown?

There are several reasons why I would prefer text:

  • The Jupyter viewer on GitHub often fails to display the content
  • It's much easier to search through the documentation with standard command line tools
  • I don't need to install Jupyter to see the documentation locally
  • I can easily see what changes with time looking at the git diffs
  • I can read the documentation with the editor I like, and not with an internet browser

In general, I don't see any benefit in having the documentation in the form of Jupyter notebooks, so I would love to have a more accessible way to read the docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions