@julianstirling @kaspar @amchagas @nick
Nick and I were thinking about our BOM / assembly instructions software… Here’s what we thought.
We really like + want:
- Follow scroll of OHAI - https://ohai.lulzbot.com/project/mini-v104-thermal-insert-instructions/mini-v104/. See how the directions follow you down the page, and there’s a text section and image section. We think that’s good design.
- Comments of Prusa - https://manual.prusa3d.com/Guide/1.+Introduction/1045?lang=en. See the ‘comments’ link under each part… that’s super helpful.
- Table of contents is visible on sidebar (and disappears to hamburger in mobile) - none of them do this, but many normal doc pages do, like this: https://our-sci.gitlab.io/rfc-docs/#/sidebar
- Object-oriented BOM links - https://gitbuilding.io/syntax/. This is spot on, and we need more object oriented links within a BOM / assembly solution.
-
No python installation plz!!! - Can’t we just do this in gitlab? Look at all the amazing uses of the gitlab pipeline with things like Docsify to auto-generate pages from wiki or gitlab docs - an example we already use is https://our-sci.gitlab.io/rfc-docs/#/. Why is this nice - I’ll tell you!
- Gitlab is open source, free, used by lots of people, and has structures built around it you’d want (like permissions, comments, version control, etc. etc.)
- It’s super easy to edit, and already uses markdown
Sooooo…
Is it possible to use Gitbuilding’s very smart structure with Gitlab’s existing wiki/comments/versioning and an auto-generating bit of code like mkdocs or docsify but making the output HTML structured more like OHAI (text on left side, picture on right, auto-scroll?)?
That would be free, easy, pretty, and serve both as external AND internal parts + assembly documentation (no duplicate assembly docs).
That to me feels like documentation heaven. If the answer is ‘sounds great but that’s a ton of work’ that’s ok, just wanted to at least share our thoughts.