Differences

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

--- developers:feedbackaug2017 [2017/08/11 11:23] – Xavier Gonze
+++ developers:feedbackaug2017 [2019/10/24 02:43] (current) – removed Matteo Giantomassi
@@ Line 1: / Line 1: @@
-====== Feedback page ======
-The suggestions are :
-First, visualize (with your favourite browser) the file ~abinit/doc/users/generated_files/help_features.html. This is our suggested entry point in the newly structured documentation. Read quickly this page, explore some of the topics, surf using the banner, look at the bibliography, search some input variable using the searching tool at
-~doc/input_variables/generated_files/varset_allvars.html, etc, etc ...
-  - Any suggestion of new Topic in help_features.html ? Is this file Ok to replace the old features.html ?
-  - Any suggestion concerning the whole newly structured documentation ?
-Then, do some modification in the YAML files, and then report to us whether the documentation
-for developer is sufficiently complete. Start with [[developers:generate_doc]].
-Could you choose one topic you are familiar with, read it carefully and improve it ?
-We mean either improving the text and/or correcting the list of attached input variables with their "Topics" and "Tribe", and/or adding some related input file and/or storing some bibliographical reference in the abiref.bib file, and replacing it by a shortcut. You might as well improve the YAML file of some lesson of the tutorial or of some help file, by storing some bibliographical reference in the abiref.bib file, and replacing it by a shortcut, or by replacing any other explicit URL by a shortcut.
-  - Was the documentation adequate for you to perform the task ?
-Do not hesitate to suggest an improvement in the procedure as well (we will see whether the improvement is not problematic).
-===== Comments ? =====
-** Please, use freely this feedback page to post your comments about the newly structured documentation. **