Documentation loic
Update a little bit the structure and add cooling.
I have created a new directory called NewOption
where I have written the most important step to do when creating a new option. I am using some links between the files to make it easily accessible and avoid useless copy. Feel free to use it in the Hydro.
By the way, we have a documentation milestone now.
Merge request reports
Activity
changed milestone to %Documentation
I think he is for the opposite. The main reason to have the 'adding a new {x}' part separated from the option is to decrease the amount of work required to maintain the doc (and therefore to ensure a documentation up to date). I just want to centralize the common part. If you need to write some specific stuff, you can write it just after giving the link.
It's unclear to me how separating it like this would reduce the amount of work required to keep the docs up to date? Could you elaborate please?
@matthieu, the two strategies here are:
Loic:
- Hydro Schemes
- Gadget
- ...
- Equations of State
- 4/3 power law
- ...
- Adding new Schemes
- Adding a new Hydro Scheme
- Adding a new EOS
Me:
- Hydro Schemes
- Gadget
- ...
- Adding a new Hydro Scheme
- Equations of State
- 4/3 power law
- ...
- Adding a new EOS
- Hydro Schemes
Ok I see now the problem. I want this:
-
Hydro Schemes
-
Gadget
-
Adding a new Hydro Scheme
- Link to Adding a new ...
- Specific stuff
-
-
Equations of State
-
4/3 power law
-
Adding a new Hydro Scheme
- Link to Adding a new ...
- specific stuff
-
-
Adding new Schemes
- What to do
Therefore we do not have to write the full list of required modifications (e.g. Makefile.am, configure.ac, ...) for each options.
-
Ok. I think, the common stuff related to creating a new file in sub-driectory and editing the Makefiles and configure scripts should be somewhere in common.
For each kind of stuff there will be specificities which need to be highlighted and then these sections can refer to the more general "how to add stuff blob".
Does that make sense?
@lhausammann if you're happy with my minor changes I'll merge.
mentioned in commit b413ec4f