diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md index 5a8d294..72eb544 100644 --- a/docs/source/user_guide.md +++ b/docs/source/user_guide.md @@ -1,20 +1,12 @@ -# Introduction - -```{eval-rst} -.. toctree:: - :maxdepth: 2 - :caption: Contents: -``` - This document provides guidance on using the Objective Seasonal Outlook Package (OSOP) toolkit for producing seasonal based forecasting and verification. This user guide includes three main sections: -* [Initial set_up](set_up) -* [Running the toolkit](run) -* [Developing the toolkit](devel) +* [Initial set_up](set_up.md) +* [Running the toolkit](run.md) +* [Developing the toolkit](devel.md) This user guide contains instructions on how to get started with the package using the currently available functions. The code is @@ -40,7 +32,7 @@ The goal is that the user does not need to be experienced in coding to use the OSOP toolkit at a basic level. Users more advanced in coding may find that they can edit further down in the software to get more highly specific use cases. As outlined in the section -[development](devel), we encourage you to share your results with the +[development](devel.md), we encourage you to share your results with the community by submitting a pull request on the main repository so that others can benefit from the same changes. Similarly, if a user feels they have identified a need that is not available within the product @@ -53,4 +45,4 @@ future changes to the toolkit by the producers may affect this guidance document. It is recommended to regularly update the toolkit locally to ensure that it is in sync with the main remote branch and includes all recent changes. Guidance on how to do this can be found -in the section [Development](devel). +in the section [Development](devel.md).