These are some steps to follow when making changes to documentation.
- Checkout a new branch from
main(e.g.git checkout -b docupdate). - Instantiate the environment in the
docsfolder by running] instantiatein the Julia REPL. - Make changes to the documentation files in the
docsfolder and/or the example scripts in theexamplesfolder. - You can iteratively make changes and build documentation to serve locally by running the
serve.jlscript from thedocsfolder using this commandjulia --project=. -e "using Pkg; Pkg.add(\"LiveServer\"); include(\"serve.jl\")" --threads auto - Once you push to origin (github.com/NatLabRockies/PRAS) and create a pull request, the documentation will be built and served at https://NatLabRockies.github.io/PRAS/previews/PR{#}. Once the changes are merged to
main, the documentation will be available at https://NatLabRockies.github.io/PRAS/dev. On tagging a PRAS version for release, the documentation will be available at https://NatLabRockies.github.io/PRAS/stable and https://NatLabRockies.github.io/PRAS/vX.Y.Z (where X.Y.Z is the version number). - More instructions on version tagging and release can be found in the Documenter.jl instructions.