Skip to content

October: open-source docs for Sawppy! (SGV LUG + WTD LA)

Photo of Andrea Kao
Hosted By
Andrea K.
October: open-source docs for Sawppy! (SGV LUG + WTD LA)

Details

This month, we continue to join forces with the SGV Linux Users Group.

We are going to have a discussion of project documentation for Sawppy (https://github.com/Roger-random/Sawppy_Rover/tree/master/docs), which will be broadly applicable to other open source hardware projects.

We are especially on the lookout for hardware-focused documentarians to join the discussion and provide their insights!
...

ABOUT SAWPPY:

Roger Cheng created Sawppy, a motorized quarter-scale model of Mars rovers Curiosity & Perseverance. The design was shared publicly for free so that other rover fans around the world can build (and have built!) their own Sawppy from parts costing about $500 USD.

However, there is a lot of room for improvement in Sawppy documentation, which is currently a loose collection of Markdown files on GitHub. Roger would like to brainstorm tools and techniques to add some much-needed structure. Currently, his primary goal is to add metadata that indicates dependencies between parts and subassemblies (enough to auto-generate a Gantt chart).

Roger also hopes to preserve the project's capacity for community involvement (i.e., in the way that maintaining Markdown files on GitHub allows for easy contributions and reviews via pull requests).
...

OTHER DISCUSSION TOPICS FOR OCTOBER:

  • Hacktoberfest
  • GitHub Classroom

As usual, we'll hold space for people to introduce themselves and chat about some of the things they've been working on.
...

TOPICS THAT WE DISCUSSED IN SEPTEMBER:

  • developing a curriculum to teach students how to build the JPL Pulse pendant

  • WTD Portland conference presentations - thanks to Aidan Doherty for sharing his notes!

  • this: https://documentation.divio.com/
    ...

WOULD YOU LIKE TO TALK ABOUT SOMETHING ELSE?

Bring it up at the meetup, leave a message here, or get in touch via the Write the Docs Slack:
https://www.writethedocs.org/slack/

(We hang out in the #los-angeles channel.)

This meetup will not be recorded.

You can learn more about SGV LUG here:
https://www.meetup.com/SGVTech

Photo of Write the Docs Los Angeles group
Write the Docs Los Angeles
See more events