[develop]: Update user_guide.md to include links to other doc versions #1049
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FernandoAndrade-NOAA
added
the
documentation
WenMeng-NOAA
added
Ready for Review
WenMeng-NOAA
approved these changes
Sep 23, 2024
|
There is no need to run the UPP RTs since the changes are only related to documentation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the
user_guide.mdfile in the source code to include links to other versions of the technical documentation in the UPP gh-pages branch.The HTMLs needed to be generated and added to gh-pages before the final
user_guide.mdfile was merged to develop; otherwise, there would be no HTMLs for theuser_guide.mdto link to. Now that the HTMLs for each version of the code have been added to gh-pages, the newly testeduser_guide.mdfile can be updated in the source code.Resolves Issue #1047 .
You can see the new documentation & links here: https://gspetro-noaa.github.io/UPP/index.html.