Skip to content

Decide on theory guide format #3

@EvertBunschoten

Description

@EvertBunschoten

Apart from the description of functions and modules, the documentation of SU2 DataMiner needs to contain a theory guide on processes like how the mixture fraction is calculated for FGM problems or a description of the workflow for table generation.
I see two options for integrating the theory guide into the documentation:

  1. Integrate descriptions of the key processes in the files under 'documentation' which describe the functions of each module.
  2. Create a separate folder with files on each process for the theory guide.

Expected outcome: Template on theory guide integration, identify which modules of SU2 DataMiner need a theory guide.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions