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

Make editable pages for each assembly instruction packet #130

Merged
merged 15 commits into from
Jul 8, 2024
Merged

Conversation

bsubbaraman
Copy link
Member

Addresses #111

Changes:

  • added new docs pages which include each page of the assembly pdf packets. each page has a header, so that others can add notes about their issues/changes/etc while assembling a jubilee.

@sgbaird
Copy link
Collaborator

sgbaird commented Jun 14, 2024

Awesome, this looks great @bsubbaraman!

I've made a number of updates. Please have a look.

Some random notes:

  • Removed "next-->" since this is taken care of with the toctrees
  • Collapsed most of the top-level stuff into building_a_jubilee.md

Do you mind taking care of the following items?

  • Add descriptive titles for each of the pages image (looks like most pages should have a title at the bottom-right of the image)
  • Consider adding the section 2 video links from https://jubilee3d.com/index.php?title=Assembly_Instructions on the corresponding pages
  • We also want to add instructions for the electronics, firmware setup, software setup, and "first flight" checks. Maybe start off with just the electronics piece?
  • Let's embed the videos where appropriate. Probably using sphinx-contrib.youtube. See https://chatgpt.com/share/90256551-f9e6-4755-bcc5-9c1b0d21f504.
  • Any clarifications to add on later wiring for tools? (especially regarding what people purchase). Ideally, people should buy everything in one go at the beginning if they already know which tools they want to use.
  • Perhaps the lab automation deck should go into the "Building a Science Jubilee" portion rather than in the "Science Jubilee Tools" portion.

@sgbaird
Copy link
Collaborator

sgbaird commented Jun 14, 2024

I'm seeing the docs\getting_started\new_user_guide.md now.

I think building the science jubilee is sort of the "real" getting started.
image

Given the changes in this PR, might be worth thinking what might benefit from restructuring and moving.

@bsubbaraman
Copy link
Member Author

Thanks for these updates @sgbaird! Bringing @brendenpelkie in to discuss reorganization since you added this helpful new user guide.

How do we want to organize the docs? 'Getting Started' currently primarily refers to the science-jubilee python codebase. Should we rename 'Getting Started' to 'Using science-jubilee to control your machine' or something? Then maybe we can divide the New User Guide information between the 'building a jubilee' and the software sections? I also see the utility in having a high-level end-to-end guide which gives people a sense in what needs to happen to go from nothing to an experiment.

@brendenpelkie
Copy link
Collaborator

Great to see this, I didn't realize this was in progress when I added the new user guide! I think we are bumping up against some tension between having these docs be for "science-jubilee, the python package for controlling Jubilee" and "science Jubilee, the place to come learn how to do experiments with Jubilee". I would advocate for leaning into the latter in our docs and making science-jubilee docs as much of a one-stop-shop for jubilee guidance as possible. Jubilee for science is really starting to get some traction in the community, and we should make sure new users have a clear path forward when getting started. There might be other organizational schemes for this that are worth considering, but we should settle on something. (ex, split the python package docs and general guidance docs). I opened #125 with the goal of discussing this. I think we should consider how to organize the entire project as well, in addition to the docs. Are we outgrowing the current setup of having everything (code, tools, config, guidance/docs) in one github repo, or is this a simple solution that gets the job done?

Back to the original question, I think it makes sense to have an obvious landing section aimed at someone who heard about Jubilee somewhere and wants to see what it's about. This might look like the front page but with more details, maybe a text version of how we introduce Jubilee in talks/posters/etc. Then the obvious next step might be something like my 'new user guide' that gives a detailed walkthrough of how to get up and running on Jubilee, from buying the kit all the way to running an experiment. 'Getting started' might be a bit of an understatement for this section.

I'm currently onboarding 3 new Jubilee users (2 MechE students and 1 ChemE PhD student). I expect to have clearer thoughts on this in a week or so after seeing how they feel about the learning process.

@sgbaird
Copy link
Collaborator

sgbaird commented Jun 27, 2024

EDIT: migrated much of this discussion to #125 per @brendenpelkie's suggestion.

@sgbaird sgbaird merged commit 20347c2 into main Jul 8, 2024
4 checks passed
@sgbaird sgbaird deleted the docs-update branch July 8, 2024 17:39
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

Successfully merging this pull request may close these issues.

3 participants