jeff-dh / SolidPython

A python frontend for solid modelling that compiles to OpenSCAD
137 stars 24 forks source link

Improve docs #52

Open jeff-dh opened 11 months ago

jeff-dh commented 11 months ago

46 was a first step towards improving the docs, but I'm not really happy with the result.

I now tend to create a subfolder inside the solid2 repo which contains markdown docs and could be hosted as git-hub page.

This is done for the jupyterscad repo:

https://jreiberkyle.github.io/jupyterscad/ https://github.com/jreiberkyle/jupyterscad/tree/main/docs

Furthermore the docs can be extended. We could easily create new docs as issues arise and create docs pages as answers for (most of) the issues.