Improving `aguaclara_tutorial`

[oliver-leung]

When I first tried working through it, I felt that the original iteration of the aguaclara_tutorial repository and wiki had room for improvement. It was verbose, complex, and confusing to navigate. Over the summer, I decided to begin the process of rewriting the tutorial's repository and the wiki, but unfortunately, wasn't able to finish before the semester came by and I got caught up with classes.

I managed to get partway through rewriting the "Python and Hydrogen" section. I hope to complete the rest of the tutorial by the end of this semester, as well as find others who would be willing to help out! I have rewritten up to (and including) Running Python Code with the following ideas in mind:

• Simplicity: Tutorials should be as short as possible, while getting the most information across. A great way to do this is to break up steps into lists that AguaClarians can easily go through.
• Accessibility: Tutorials should presume as little knowledge as possible, so that everything is clear, even to someone who has never written a line of code.
  • Intuitive navigation: A custom-made sidebar makes it significantly easier to glance at the entire tutorial and see which sections need to be completed.

[jillianwhiting]

How is this going?

[oliver-leung]

I recently was exposed to the wonders of Sphinx documentation and GitHub Pages (as is used in the Textbook), so I plan to move the tutorials over to that format, which will make them a lot easier to use and revise.

Other than that, I just need to rewrite the Git and Github sections of the tutorial. I can get this done by next Tuesday/Wednesday, but I may also be making some additions/revisions before next semester.

[jillianwhiting]

sounds great! Thank you for your hard work.