Best way to put documentation for FreeCAD community

Discussion about the development of the Assembly workbench.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
askoh
Posts: 21
Joined: Mon Mar 06, 2023 6:16 pm
Location: Los Alamos NM
Contact:

Best way to put documentation for FreeCAD community

Post by askoh »

I have documentation of my Assembly Constraint and Multibody Dynamics formulations in OpenOffice format. I would like to publish them on Github, or some better place, for the FreeCAD community to see, critique, edit, or help implement them in FreeCAD. Any advice is appreciated.
Example files are attached. ODT file can be edited by LibreOffice or OpenOffice.
0000summary.pdf
(202.75 KiB) Downloaded 73 times
0000summary.odt
(809.84 KiB) Downloaded 40 times
User avatar
kwahoo
Posts: 680
Joined: Fri Nov 29, 2013 3:09 pm
Contact:

Re: Best way to put documentation for FreeCAD community

Post by kwahoo »

Hi,
If you are going put these docs on Github, please consider saving them as Flat XML (*.fodt). It is more VCS-friendly than default ODT.
askoh
Posts: 21
Joined: Mon Mar 06, 2023 6:16 pm
Location: Los Alamos NM
Contact:

Re: Best way to put documentation for FreeCAD community

Post by askoh »

kwahoo wrote: Thu Apr 13, 2023 8:28 pm Hi,
If you are going put these docs on Github, please consider saving them as Flat XML (*.fodt). It is more VCS-friendly than default ODT.
Excellent suggestion. I was not aware of *.fodt format.
Should I publish just the fodt only or fodt and pdf too?
Thanks,
Aik-Siong Koh
Post Reply