Hey there, and welcome to the my Onshape-Boat-Tutorial repository! This project contains the source code for an instruction set I created as part of an assignment for my upper division writing class. The document serves a second purpose: a guide to help new Cyclone RoboSub members get familiar with Onshape, a cloud-based CAD platform.
I typeset this document using a markup language called Typst with assistance from a variety of tools listed below. Creating this document from scratch was an incredibly enjoyable process, and I highly recommend Typst for any professional documentation needs. To offer insight into my work-process, I’ve left commented sections in the source code.
- VS Code + Tinymist - For writing and rendering Typst code locally in real-time
- Krita - To annotate and draw on screenshots
- SVG Gobble - For extracting scalable SVGs from Onshape user interface
oasis-align- A custom Typst package I developed for precise content alignment
I am extraordinarily proud of the final product, and much of my success is in part thanks to the amazing toolset that I had at my disposal--especially Typst. I believe that this document showcases Typst's potential for creating polished, professional documentation.
One of Typst’s standout features is its ability to separate style from content. This allows me to focus on writing without being distracted by formatting concerns. When I’m ready, I can seamlessly transition into editing the document’s layout and style.
Typst’s dynamic nature particularly shines in layout design. Its adaptive layout functions ensure that changes to content have minimal impact on the overall structure. For example, my oasis-align package dynamically adjusts figure sizes based on their context, enabling a smooth and efficient workflow.
Thank you for exploring this repository! Please feel free to reach out if you have any questions. I hope it inspires you to try Typst and explore its capabilities for your own projects!
