Giters

nteract / commuter

🚎 Notebook sharing hub

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

End-user docs?

drwelby opened this issue · comments

commented

Are there docs or demos showing Commuter in use? I looked at the demo glitch version and the functionality I see so far is:

  • view a file tree
  • open a rendered notebook
  • download a notebook

What is not clear to me:

  • The function of the Discoveries tab
  • what supports the Contents API means to the end user
  • what sharing specifically means

Is it functionally like having notebooks in Github (list, preview), minus Github?

commented

Thanks for opening this issue, @drwelby!

We, unfortunately, don't have docs for the points that you mentioned.

@willingc Would you want to spend sometime pairing on this? I find that pairing helps me focus on getting these types of things done.

@rgbkrk Do you know if there is some internal docs on commuter that we could reuse here?

commented

Sure @captainsafia. That would be great.

commented

Thanks for looking into this!

Instead of documentation, a slide deck or video that shows a Commuter instance in use work equally well. Or even if someone could spare 5 minutes to give me a quick walkthrough of one over screenshare.

I feel like I understand 75% of what Commuter can do, but it's what's in that other 25% that is interesting to us.