GitBuilding: Open source documentation for open source hardware
summary
GitBuilding is a toolchain for writing hardware documentation alongside design files in Git using Markdown plus extra semantic syntax. It extracts metadata and tags to auto-generate bills of materials, link and reuse assembly steps across variants, show 3D previews, and produce outputs in Markdown, HTML or PDF. The project grew from the OpenFlexure Microscope use case and aims to generalize its data model for broader open-hardware and manufacturing needs so documentation can support reproducibility and regulatory-quality manufacturing.
AI-written summary · about
related talks
44mPushing documentation (so it doesn't hurt anymore)
35mThe practical implementation of Documentation as Code
25mBuilding Docs like Code: Continuous Integration for Documentation
21mHow to create a culture of hardware sharing in academia
47mEngineering Documentation
56mEffective Documentation: The Key to Open Source Growth
05mDocs as Part of the Product: Open Source Technical Documentation at Scale
36mBuilding Docs like Code: Continuous Integration for Documentation