From 894bbacbc0b1989644bec3c381c1175c304d0807 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Val=C3=A9rian=20Rey?= <valerian.rey@gmail.com>
Date: Sun, 6 Apr 2025 13:13:13 +0200
Subject: [PATCH] Explain how to open the documentation of a PR

---
 CONTRIBUTING.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9ca2045d4..5287551cc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -47,7 +47,10 @@ with maintainers before implementing major changes.
     pdm run pytest tests/unit tests/doc --cov=src
     ```
 
-## Building the documentation locally
+## Building the documentation
+
+### Locally
+
    - From the `docs` folder, run:
      ```bash
      pdm run make html
@@ -59,6 +62,13 @@ with maintainers before implementing major changes.
      pdm run make clean
      ```
 
+### Online
+
+- When you open a pull request, a GitHub action should build and deploy the documentation, which
+  will become available at `torchjd.org/pr/<pr_number>`. Additionally, you can click on the check
+  status of the action, then click on `Summary`, and then click on the link of the built
+  documentation.
+
 ## Development guidelines
 
 The following guidelines should help preserve a good code quality in TorchJD. Contributions that do