The Wayback Machine - https://web.archive.org/web/20200702222537/https://github.com/jupyter/nbviewer/issues/654
Skip to content

/ nbviewer

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

Jump to bottom

No docs other than the README (either user or developer) #654

Open
mpacer opened this issue Dec 22, 2016 · 1 comment
Open

No docs other than the README (either user or developer) #654

mpacer opened this issue Dec 22, 2016 · 1 comment
Labels
tag:Documentation type:Enhancement

Comments

@mpacer
Copy link
Member

@mpacer mpacer commented Dec 22, 2016

Currently nbviewer looks to be largely undocumented (outside of the README) for either user or developer docs.

I'm not sure if this was a choice, and I don't know as much about documentation for javascript applications, but this seems (at best) suboptimal.
@minrk
Copy link
Member

@minrk minrk commented Jan 3, 2017

suboptimal is generous :)

nbviewer's grown well beyond its original scope, and we should probably put together more thorough docs. In particular, it was not originally intended to be deployed anywhere other than nbviewer.jupyter.org, so covering the many ways it can now deployed didn't originally make sense.

Now that it's somewhat organically become a 'real' service that others can deploy, we should take a run at covering how this can be done, describing the 'providers' notion, etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag:Documentation type:Enhancement
3 participants
@minrk @parente @mpacer
You can’t perform that action at this time.