idaholab / TMAP8

Tritium Migration Analysis Program, Version 8
https://mooseframework.inl.gov/TMAP8/
GNU Lesser General Public License v2.1
14 stars 17 forks source link

Link V&V documentation to input files #150

Open simopier opened 2 months ago

simopier commented 2 months ago

Reason

It would be best for users if the documentation for the verification, benchmarking, and validation cases all pointed to the input file corresponding to the results shown in the documentation.

Design

Add the following section in the documentation page of verification and validation cases:

### Input file

!style halign=left

The input file for this case can be found at [/input_file_name.i].

As @cticenhour suggested in #146, we could use the listing extension to display the whole input in a scrollable code box. But that is optional, since clicking this link will also open a scrollable modal with a code box.

Impact

Better documentation and experience for the users, and more transparency.