Login  Register

Re: Documentation Standards

Posted by Gary S on Nov 25, 2018; 5:36pm
URL: https://forum.librecad.org/How-to-Contribute-tp5716606p5716679.html

Initially, yes there will be some double-handling until everything is moved over to GitHub.  Once eveything has been moved to GitHub the documents can be versiomed / forked /updated / revised with each release - hopefully easier than trying to maintain it on the wiki.

I'll have a look at Pandoc.  Right now I just copy & paste and then updated the source files for the documentation with the appropriate markup (markdown or reStructuredText) with some search & replace.  I'm collecting materials from a variety of sources; the wiki, the forum, source code and my own documentation.  I've been using the wiki landing page as a starting point for the documentation layout and content.  Much of it needs to be updated and/or expanded on.

I'll have to go back and look and see if I've mentioned this, but the intent is for new contributions (via the forum or the wiki) to be as simple as possible, i.e. plain text, and then the formating done in the GitHub document source.

Utimately the end-user documentation will be hosted on readthedocs.io as html, pdf or epub documents.  Each format is generated from the source as required.  readthedocs.io hooks into Gitb, so the documents get updated automatically.  I've been using my own repositry to