diff --git a/documentation/smg/10_build_release_process.md b/documentation/smg/10_build_release_process.md index 9e8e94b7e9..ab1dcc18bc 100644 --- a/documentation/smg/10_build_release_process.md +++ b/documentation/smg/10_build_release_process.md @@ -65,7 +65,11 @@ The version number is stored in a text file (`VERSION`) in the root of the Herbert and Horace source. This will follow [semantic versioning](https://semver.org/) and is used in the build process to set the version number in the MATLAB -and compiled C++ components. +and compiled C++ components + +The number of the latest version is referred to in README.md in +`documentation/user_docs`. When updating the release as above, that reference +in the README should also be updated. ## Deployment on ISIS computational services machines diff --git a/documentation/user_docs/README.md b/documentation/user_docs/README.md index 4c7837334d..38b819add9 100644 --- a/documentation/user_docs/README.md +++ b/documentation/user_docs/README.md @@ -36,10 +36,23 @@ To build the docs locally: Built documents will be put in the `/build/html` folder, the main file is the `index.html` file. ## Online documentation -Horace documentation is also available from: +The latest stable Horace documentation is also available from: -https://pace-neutrons.github.io/horace-docs/latest +https://pace-neutrons.github.io/Horace/stable -For this version, see: +where `/stable` can be omitted. The latest development version of the +documentation can be obtained by replacing `stable` with `unstable`. -https://pace-neutrons.github.io/horace-docs/3.5.0/ +`Horace` and `Horace/stable` both immediately redirect to the path of the +latest stable version, which is currently: + +https://pace-neutrons.github.io/Horace/v3.6.3/ + +This version number should be changed when a new release is produced; details +for this can be found in `smg/10_build_release_process.md`. + +Older versions are available; to see these, enter the Horace repo at the +top level and switch to branch `gh-pages`. + +Details on the use of this branch to store release documentation can be +found in `adr/0002-use-github-for-documentation.md`.