MillenniumMachines / Milo-v1.5

Milo is an open-source project for DIYers to create a reliable, low cost and powerful desktop CNC mill on their own terms.

Home Page:http://milo.diycnc.xyz

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Assembly manual only available through another channel

8000ff opened this issue · comments

Currently the assembly manual is available as a google docs

Documentation not versioned alongside the rest of the project

This creates a high potential for a disconnect between what's written and what's true.
It also prevents people from quickly contributing small changes.

Documentation format

If the assembly manual is going to be added to this repository, I assume (maybe, wrongly) that it'll be a PDF.
The PDF format (as a binary format) can induce very big diffs (changes in the raw file) for even tiny changes in the displayed output, these can create conflicts and prevent a smooth collaborative workflow.

Recommendation

Knowing this project is maintained and used by a lot of non-developers, I can't recommend going with a "tech heavy" solution (for now) as it would bring too little value and create much work for the maintainers.

I think a good compromise could be using simple markdown files in a docs directory.