Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Textual documentation #51

Open
Sbozzolo opened this issue Sep 1, 2019 · 0 comments
Open

Textual documentation #51

Sbozzolo opened this issue Sep 1, 2019 · 0 comments

Comments

@Sbozzolo
Copy link

Sbozzolo commented Sep 1, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant