How to Contribute

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

How to Contribute

Gary S
The documentation for LibreCAD will ultimately end up in a GitHub repository where it can be maintained and updated as new versions of the application are released.

There are several paths that the will lead to the documentation on GitHub, but generally it starts with a submission from anyone who wants to contribute.  Submissions can be via the forum, as a post (or as an email), directly to the wiki, or even via GitHub – what ever is the easiest for the contributor.

Eventually all relevant submissions be taken from the wiki and copied into the user documentation ‘source code’ that will be hosted on GitHub.  Documents hosted on GitHub uses GitHub’s own formatting (markup language), so any submissions from the forum or wiki will need to be modified by the maintainers as it is incorporated into the documentation source.  As the documentation will need to be edited by the maintainers, extensive formatting of a submission should be avoided.

To help with the organization of the user documentation, a ‘landing page’ has been created on the wiki.  The link to the landing page can be found in the sub-forum’s head line.  The landing page is the outline for the “LibreCAD User Documentation” with the proposed sections and links to related pages.  The wiki is very much a live documentation and will be changing as the wiki is added to, modified, etc.
Reply | Threaded
Open this post in threaded view
|

Documentation Standards

Gary S
The user documentation will require some standards to provide a consistent structure, style, format, and appearance.  Some of that will be driven by what is available in GitHub’s markup language (called “Markdown”), but other things to consider will be how to incorporate images, tables, etc.  Watch here for further discussions on the standards as they develop.