-
-
Notifications
You must be signed in to change notification settings - Fork 24
Home
This wiki provides information to individuals that want to contribute to LibreCAD's documentation. Currently the documentation consists of the User Manual (maintained on GitHub, hosted on Read the Docs) and Tutorials (hosted on the LibreCAD wiki).
Read the Docs (RtD) provides free hosting for open source projects, is well connected with github (our source code provider) and supports different offline output formats. In addition to the online version we can automatically create PDF or eBook for example. And all of this for different versions!
RtD uses a documentation generator, called Sphinx, which uses an advanced markup language (restructuredtest - See the Resources page). The environment may seem daunting, but there are a variety of ways to contrbute without having to understand the environment or learn a new markup language.
There are a few ways to contribute to the LibreCAD Manual, in order of difficulty:
- simple text via the forum or email (Easiest - leave it to the authors / editors to sort out the formating and integration.)
- via the wiki (Intermediate - supports images and some layout. Leave it to the authors / editors to sort out the formating and integration.)
- restructuredtext via github (Difficult - need to know git, github, markup language (restructuredtext), the documentation and writing standards.)
More information and resources are provided in the section shown on the right.