Login  Register

Re: Documentation Standards

Posted by LordOfBikes on Nov 26, 2018; 9:02am
URL: https://forum.librecad.org/How-to-Contribute-tp5716606p5716683.html

I've setup the github repo at https://github.com/LibreCAD/docs
and hooked it to a LibreCAD account at readthedocs.io

The HTML docs are available at https://librecad.readthedocs.io/en/latest/

The repo contains only, what sphinx-quickstart has produced. This is a starting point only and we can now apply a template, structure and docs.

@Gary_S, when you have a github account and feel safe in dealing with git/github, we can consider write permission for you. The other option is the pull request way, which will work anyhow.

@ubiquitous, hopefully not most docs will need double-handling.
Our fear is, to scare off authors who are not versatile with git/github or sphinx.
Preferably contributors will have experience with the docs tool chain and contribute with pull requests on github.
Only for those who are not, the wiki should be the place to contribute. Experienced contributors can maintain this and carry over the wiki docs to github.

Armin
investing less than half an hour into Search function can save hours or days of waiting for a solution