beauty:2018
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
beauty:2018 [2018/06/02 17:33] – [I have not yet familiarized myself with abimkdocs / markdown] Xavier Gonze | beauty:2018 [2018/06/03 23:11] (current) – [What should be done ?] Xavier Gonze | ||
---|---|---|---|
Line 28: | Line 28: | ||
This beautification will be focused on the documentation. Indeed, as a response to the recommendations made at the last developer workshop, in Frejus May 2017, " | This beautification will be focused on the documentation. Indeed, as a response to the recommendations made at the last developer workshop, in Frejus May 2017, " | ||
- | * A. it is likely that there are still isolated bibliographical references in the descriptions of input variables or lessons of the tutorial (or other files), | + | * A. There are still MANY isolated bibliographical references in the descriptions of input variables or lessons of the tutorial (or other files), |
- | * B. Equations might still be in " | + | * B. Many line breaks have disappeared in the input variable descriptions (so, one big paragraph appears instead of several paragraphs) |
- | * C. specific | + | * C. Equations might still be in " |
- | * D. it remains to be checked that no inadvertent deterioration of the documentation has occurred. | + | * D. Specific |
- | * E. one might also check the correctness of links and other information (like the coherence between the sections of output files pasted in the text, and the output files themselves, available from the links) | + | * E. It remains to be checked that no inadvertent deterioration of the documentation has occurred. |
+ | * F. One might also check the correctness of links and other information (like the coherence between the sections of output files pasted in the text, and the output files themselves, available from the links) | ||
| | ||
As an indication, each contributor might have to dedicate about three hours to this work (including, if not yet done, reading the mkdocs documentation and possibly training a bit with the mksite script). By the way, suggestions for improvements of the mkdocs infrastructure is also welcome, see the dedicated page. | As an indication, each contributor might have to dedicate about three hours to this work (including, if not yet done, reading the mkdocs documentation and possibly training a bit with the mksite script). By the way, suggestions for improvements of the mkdocs infrastructure is also welcome, see the dedicated page. | ||
Line 40: | Line 41: | ||
Check first whether it exists already in the bibliographical database | Check first whether it exists already in the bibliographical database | ||
(file doc/ | (file doc/ | ||
- | Otherwise, | + | Otherwise, |
- | [[https:// | + | [[https:// |
==== I have not yet familiarized myself with abimkdocs / markdown | ==== I have not yet familiarized myself with abimkdocs / markdown |
beauty/2018.1527953614.txt.gz · Last modified: 2018/06/02 17:33 by Xavier Gonze