diff --git a/docs/source/how-to-update-these-docs.rst b/docs/source/how-to-update-these-docs.rst index 621fed59d..10d951791 100644 --- a/docs/source/how-to-update-these-docs.rst +++ b/docs/source/how-to-update-these-docs.rst @@ -69,7 +69,7 @@ Once you have these pre-requisites, you can follow the steps below to update the - If adding new pages, ensure they are added to the "toctree" at the top of the `index.rst` file present in the same directory. -5. [Optional] Build the documentation locally to check that your changes are rendering correctly. +5. [Optional] Build the documentation locally to check that your changes are rendering correctly. Note: when opening a pull request in the last step you will be able to see a preview of the changes on GitHub anyway, but this could be quicker if you have a lot of changes to check. - Install the required dependencies for building the documentation. You may wish to use a virtual environment to avoid conflicts with other Python packages. @@ -118,6 +118,11 @@ Once you have these pre-requisites, you can follow the steps below to update the - Click "Create pull request" and add a descriptive title and description to the pull request. + - The documentation will be built automatically and you will be able to see a preview of the changes on the pull request page. Click "Details". + + .. image:: img/PR_docs_preview.png + :alt: Docs preview + - A Seshat Databank Admin will review your changes and may request further changes before merging the pull request. - Once your pull request is merged, the changes will take a few moments before being reflected on this website. \ No newline at end of file diff --git a/docs/source/img/PR_docs_preview.png b/docs/source/img/PR_docs_preview.png new file mode 100644 index 000000000..f1ace746f Binary files /dev/null and b/docs/source/img/PR_docs_preview.png differ