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

End-user docs? #300

Open
drwelby opened this issue Jul 15, 2020 · 3 comments
Open

End-user docs? #300

drwelby opened this issue Jul 15, 2020 · 3 comments

Comments

@drwelby
Copy link

drwelby commented Jul 15, 2020

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?

@captainsafia
Copy link
Member

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?

@willingc
Copy link
Member

Sure @captainsafia. That would be great.

@drwelby
Copy link
Author

drwelby commented Jul 29, 2020

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.

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

3 participants