[[PageOutline]] Last edited [[Timestamp]]

'''Author''' : Gurvan Madec

'''ticket''' : #1629

'''Branch''' : [https://forge.ipsl.jussieu.fr/nemo/browser/branches/2015/nemo_v3_6_STABLE nemo_v3_6_STABLE]

----
= Description =
The documentation (both OPA and LIM3) of the v3.6_STABLE is out-of-date.

Developers should check that : [[BR]]

 * all the namelist variables are explained in the DOC, and are referenced in the doc index
 * all new or updated part of the code are explained in the documentation.

----
= Strategy =
== I. Namelist update ==
  '''  DONE'''   ===>>> see revision [https://forge.ipsl.jussieu.fr/nemo/log/trunk/NEMOGCM?rev=5890 ​5890]

 * update all the namelist of the documentation
 * addition of a script that allows an easy update of those namelist (thanks to françoise Pinsard)

== II. OPA: Out-of-date item to be updated ==
'''DONE''' ===>>> see revision [https://forge.ipsl.jussieu.fr/nemo/log/trunk/NEMOGCM?rev=6039 ​6039]  (gm)  : TEOS10 - update of EOS documentation

'''DONE''' ===>>> see revision  [https://forge.ipsl.jussieu.fr/nemo/log/trunk/NEMOGCM?rev=XXXX ​xxxx]  (gm) : update almost all ocean engine documentation as follow:

 * Biblio :  addition of several  papers.
 * Figures : remove Fig_obc_north.pdf
 * Chapters / Abstracts_Foreword : minor changes
 * Chapters / Annex_C : minor corrections in some of the equations
 * Chapters / Annex_D : update the Doctor convention for namelist (nn_, ln_, rn_ ...) and add np_ as parameter
 * Chapters / Chap_DIA : update trends diagnostics, harmonic analysis, and transport across sections.
 * Chapters / Chap_DOM : minor changes
 * Chapters / Chap_DYN : add description of e3f choice in EEN scheme ; of time-splitting in vertical momentum advection ; description of external forcing ;
 * Chapters / Chap_LBC : update North fold b.c. ; “Exchange with neighbouring processors” section ; remove OBC description
 * Chapters / Chap_LDF, Chap_MISC : minor changes
 * Chapters / Chap_Model_Basics : numerous minor changes
 * Chapters / Chap_SBC : multiple changes associated with sfx and the[https://forge.ipsl.jussieu.fr/#88922700 removal] of emps, among other things
 * Chapters / Chap_TRA : multiple changes related to sfx, emps, etc…
 * Chapters / Chap_ZDF : add a TKE sub-section describing “Mixing just below the mixed layer” (netau staff) ; phase NPC presentation with the new algorithm.
 * Chapters /  Introduction : minor changes + update of “what’s new from v2.4 to v3.6”

'''REMAINING TO BE DONE''' ===>>> Identified item that have to be updated are the following ones : 

== II. LIM-3.6 : Out-of-date item to be updated ==
 * ...
 * ...