search

oceanmodeling / ufs-weather-model

This repo is forked from ufs-weather-model, and contains the model code and external links needed to build the UFS coastal model executable and model components, including the ROMS, FVCOM, ADCIRC and SCHISM plus WaveWatch III model components.
https://github.com/oceanmodeling/ufs-coastal-app
Other
2 stars 3 forks source link

Improvements to ufs-coastal documentation #57

Open janahaddad opened 3 months ago

janahaddad commented 3 months ago

Description

Currently documentation build scripts are in ufs-coastal-app repo, and require some updates, including those mentioned in #14 as well as the following comment from @uturuncoglu:

@janahaddad I think it would be nice to add link to our documentation to point following,

https://github.com/ufs-community/ufs-weather-model/wiki/Developer-Information https://github.com/ufs-community/ufs-weather-model/wiki/Making-code-changes-in-the-UFS-weather-model-and-its-subcomponents

Solution

Opening this issue as a dedicated issue for updating the doc scripts.

Definition of Done

Let's aim for an initial decent version of the docs that is shareable and can be easily followed, even if it doesn't include everything that is ultimately needed.