-
Notifications
You must be signed in to change notification settings - Fork 334
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
Create a new to programming section #702
Comments
What comes to mind off the top of my head would be a visual at the top: atom-script screenshot --> Hydrogen screenshot --> nteract screenshot Demonstrating the same script in all three environments (perhaps making the Hydrogen shot 1/3 larger than the other two for focus). It's probably time to consider docs for most of what follows below and then keep the README as a nav to the docs and "new user" friendly discussion of languages and applications with less jargon. Linking to the docs for more detail. So... what would the team like to use to create standalone docs? |
Thanks for getting this started!
That's a great idea! @willingc I really like the idea of using standalone docs, since it would make our README less overwhelming.
What comes to my mind would be https://gitbook.com, Example: http://redux.js.org/. What do you think? I haven't tried it yet. We could also do everything manual and add it to nteract/nteract.io#7 but that means probably a lot of work and would be harder to maintain. |
I've been day dreaming a little bit about a plugin that provides an interactive tutorial on getting started. It would use tool-tips and stuff to walk through how to get your kernels installed, starting up a kernel, and running a few basic commands. |
@BenRussert Any further thoughts about an interactive tutorial? |
Thanks @kylebarron for reminding me about this comment! A nice little blast from the past for me. Initially, what stopped me from moving forward on this idea is that I was just learning js at the time and I thought i'd wait until I could handle it. Now, almost 2 years later I know I could implement something like this, but I also know it would take a fair amount of time and I'm not sure if it's what I want to prioritize. Do you think it would be valuable? As I'm writing this I'm starting to convince myself that I couId do this in a few hours... maybe I'll try getting started on it some weekend to see if I like where it's going early on 😄. |
I have no understanding for how complicated it would be. I kind of think that written documentation gives more bang for your buck, and it might be a better use of time to just create a written tutorial. |
It would be great to be able to direct more atom-script users over to Hydrogen. I hesitate a little bit since the Jupyter wording (kernels, jupyter, etc.) is quite a bit to digest in the initial part of the README.
What could we do to make Hydrogen welcoming to newer programmers who may have never used Jupyter?
/cc @willingc
The text was updated successfully, but these errors were encountered: