User Tools

Site Tools


beauty:2018

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
beauty:2018 [2018/06/02 17:33] – [I have not yet familiarized myself with abimkdocs / markdown] Xavier Gonzebeauty:2018 [2018/06/02 17:35] – [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, "topics" have been introduced and lead to completion, a centralized bibliography database has been set up, and a new global infrastructure based on mkdocs (and markdown) has been established. However: 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, "topics" have been introduced and lead to completion, a centralized bibliography database has been set up, and a new global infrastructure based on mkdocs (and markdown) has been established. However:
  
-  * 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), to be ported inside the bibliography database, see https://docs.abinit.org/developers/abimkdocs/#how-to-add-a-bibliographic-reference +  * A. There are still MANY isolated bibliographical references in the descriptions of input variables or lessons of the tutorial (or other files), [[https://docs.abinit.org/developers/abimkdocs/#how-to-add-a-bibliographic-reference|to be ported inside the bibliography database]]. 
-  * B. Equations might still be in "text" style, while they should be now in "LaTex" style (interpreted using MathJax, see https://docs.abinit.org/developers/markdown/#mathjax)+  * B. Equations might still be in "text" style, while [[https://docs.abinit.org/developers/markdown/#mathjax|they should be now in "LaTex" style]] (interpreted using MathJax)
   * C. specific improvements of lessons of the tutorials and other files could be made, thanks to the new mkdocs infrastructure.   * C. specific improvements of lessons of the tutorials and other files could be made, thanks to the new mkdocs infrastructure.
   * D. it remains to be checked that no inadvertent deterioration of the documentation has occurred.   * D. it remains to be checked that no inadvertent deterioration of the documentation has occurred.
beauty/2018.txt · Last modified: 2018/06/03 23:11 by Xavier Gonze