Doc update.

Signed-off-by: Timothy Rule (VM/EMT3) <[email protected]>

doc/Makefile

@@ -16,7 +16,7 @@ define _INDEX_MD_FILE =
 ---
 title: "DSE FMI API Reference"
 linkTitle: "FMI"
-weight: 80
+weight: 400
 ---
 
 ## DSE FMI API Reference

doc/content/apis/fmi/_index.md

@@ -1,7 +1,7 @@
 ---
 title: "DSE FMI API Reference"
 linkTitle: "FMI"
-weight: 80
+weight: 400
 ---
 
 ## DSE FMI API Reference

doc/content/apis/fmi/fmimodelc/index.md

@@ -2,50 +2,28 @@
 title: FMI ModelC FMU API Reference
 linkTitle: FMI
 ---
-## fmi2Instantiate
-
-
-Create an instance of this FMU, allocate/initialise a Fmu2InstanceData
-object which should be used for subsequent calls to FMI methods (as parameter
-`fmi2Component c`).
-
-> Note: This implementation __does not__ use memory related callbacks provided
-  by the Importer (e.g. `malloc()` or `free()`).
-
-### Returns
-
-fmi2Component (pointer)
-: An Fmu2InstanceData object which represents this FMU instance.
-
-
+## fmi2ExitInitializationMode
 
-## fmi2GetReal
 
+Initialise the Model Runtime (of the ModelC library) and in the process
+establish the simulation that this ModelC FMU is wrapping/operating.
 
-Get values for the provided list of value references.
+This function will generate indexes to map between FMI Variables and ModelC
+Signals; both scaler signals (double) and binary signals (string/binary).
 
 ### Parameters
 
 c (fmi2Component*)
 : An Fmu2InstanceData object representing an instance of this FMU.
 
-vr (fmi2ValueReference[])
-: List of value references to retrieve.
-
-nvr (int)
-: The number of value references to retrieve.
-
-value (fmi2Real[])
-: Storage for the retrieved values.
-
 ### Returns
 
 fmi2OK (fmi2Status)
-: The requested variables are retrieved (where available).
+: The simulation that this FMU represents is ready to be operated.
 
 
 
-## fmi2GetString
+## fmi2GetReal
 
 
 Get values for the provided list of value references.
@@ -61,7 +39,7 @@ vr (fmi2ValueReference[])
 nvr (int)
 : The number of value references to retrieve.
 
-value (fmi2String[])
+value (fmi2Real[])
 : Storage for the retrieved values.
 
 ### Returns
@@ -71,18 +49,6 @@ fmi2OK (fmi2Status)
 
 
 
-## fmi2FreeInstance
-
-
-Free memory and resources related to the provided FMU instance.
-
-### Parameters
-
-c (fmi2Component*)
-: An Fmu2InstanceData object representing an instance of this FMU.
-
-
-
 ## FMI ModelC FMU
 
 
@@ -113,24 +79,29 @@ center footer Dynamic Simulation Environment
 
 
 
-## fmi2ExitInitializationMode
+## fmi2GetString
 
 
-Initialise the Model Runtime (of the ModelC library) and in the process
-establish the simulation that this ModelC FMU is wrapping/operating.
-
-This function will generate indexes to map between FMI Variables and ModelC
-Signals; both scaler signals (double) and binary signals (string/binary).
+Get values for the provided list of value references.
 
 ### Parameters
 
 c (fmi2Component*)
 : An Fmu2InstanceData object representing an instance of this FMU.
 
+vr (fmi2ValueReference[])
+: List of value references to retrieve.
+
+nvr (int)
+: The number of value references to retrieve.
+
+value (fmi2String[])
+: Storage for the retrieved values.
+
 ### Returns
 
 fmi2OK (fmi2Status)
-: The simulation that this FMU represents is ready to be operated.
+: The requested variables are retrieved (where available).
 
 
 
@@ -225,6 +196,35 @@ fmi2Error (fmi2Status)
 
 
 
+## fmi2FreeInstance
+
+
+Free memory and resources related to the provided FMU instance.
+
+### Parameters
+
+c (fmi2Component*)
+: An Fmu2InstanceData object representing an instance of this FMU.
+
+
+
+## fmi2Instantiate
+
+
+Create an instance of this FMU, allocate/initialise a Fmu2InstanceData
+object which should be used for subsequent calls to FMI methods (as parameter
+`fmi2Component c`).
+
+> Note: This implementation __does not__ use memory related callbacks provided
+  by the Importer (e.g. `malloc()` or `free()`).
+
+### Returns
+
+fmi2Component (pointer)
+: An Fmu2InstanceData object which represents this FMU instance.
+
+
+
 ## Typedefs
 
 ## Functions

doc/content/docs/user/fmi/_index.md

@@ -0,0 +1,7 @@
+---
+title: "FMI - FMI Models"
+linkTitle: "FMI"
+weight: 400
+---
+
+## DSE FMI Models

doc/content/docs/user/fmi/fmigateway/index.md

@@ -0,0 +1,35 @@
+---
+title: "FMI Gateway FMU"
+linkTitle: "FMI Gateway"
+weight: 200
+tags:
+- FMI
+- Gateway
+- Model
+github_repo: "https://github.com/boschglobal/dse.fmi"
+github_subdir: "doc"
+---
+
+## Synposis
+
+FMI Gateway FMU
+
+
+## Simulation Setup
+
+### Structure
+
+#### Example Simulation
+
+```text
+
+```
+
+## FMI Gateway FMU Setup
+
+> DOC: Provide description of FMI Gateway FMU Taskfile workflows.
+
+
+## FMI Gateway FMU Operation
+
+> DOC: Operation.

doc/content/docs/user/fmi/fmimcl/index.md

@@ -0,0 +1,35 @@
+---
+title: "FMI Model Compatibility Library (MCL)"
+linkTitle: "FMI MCL"
+weight: 400
+tags:
+- FMI
+- MCL
+- Model
+github_repo: "https://github.com/boschglobal/dse.fmi"
+github_subdir: "doc"
+---
+
+## Synposis
+
+FMI Model Compatibility Library
+
+
+## Simulation Setup
+
+### Structure
+
+#### Example Simulation
+
+```text
+
+```
+
+## FMI MCL Setup
+
+> DOC: Provide description of FMI MCL Taskfile workflows.
+
+
+## FMI MCL Operation
+
+> DOC: Operation.

doc/content/docs/user/fmi/fmimodelc/index.md

@@ -0,0 +1,35 @@
+---
+title: "FMI ModelC FMU"
+linkTitle: "FMI ModelC"
+weight: 600
+tags:
+- FMI
+- ModelC
+- Model
+github_repo: "https://github.com/boschglobal/dse.fmi"
+github_subdir: "doc"
+---
+
+## Synposis
+
+FMI ModelC FMU
+
+
+## Simulation Setup
+
+### Structure
+
+#### Example Simulation
+
+```text
+
+```
+
+## FMI ModelC FMU Setup
+
+> DOC: Provide description of FMI ModelC FMU Taskfile workflows.
+
+
+## FMI ModelC FMU Operation
+
+> DOC: Operation.