Polish documentation #140
Comments
extsoft
added a commit
that referenced
this issue
Jul 15, 2019
"installation" and other related staffs have to be moved from README.md to `docs` directory. The content of CONTRIBUTING.md is published on README.md. #140
extsoft
added a commit
that referenced
this issue
Jul 15, 2019
The new Ci image is pushed (version 3) which contains Python and MkDocs installation. This allows adding a check for documentation building to the testing procedure. This procedure tries to build the HTML docs. If they build successfully, we assume that documentation is good enough. #140
Merged
extsoft
added a commit
that referenced
this issue
Jul 15, 2019
"installation" and other related staffs have to be moved from README.md to `docs` directory. The content of CONTRIBUTING.md is published on README.md. #140
extsoft
added a commit
that referenced
this issue
Jul 15, 2019
The new Ci image is pushed (version 3) which contains Python and MkDocs installation. This allows adding a check for documentation building to the testing procedure. This procedure tries to build the HTML docs. If they build successfully, we assume that documentation is good enough. #140
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We have to split user and dev documentation separately. That's why "installation" and other related staffs have to be moved to from
README.mdtodocsdirectory.Also, the content of
CONTRIBUTING.mdneeds to be published onREADME.md.The text was updated successfully, but these errors were encountered: