Merge pull request #105 from pramodk/pramodk/minor-docs-update

[Docs] Fix absolute URL links and add documentation building instructions

Author: hexinw-nvidia

CONTRIBUTING.md

@@ -83,6 +83,19 @@ git push -u origin <local-branch>:<remote-branch>
 
 4. With CI/CD process in place, the PR will be accepted and the corresponding issue closed only after adequate testing has been completed, manually, by the developer and NVRx engineer reviewing the code.
 
+#### Documentation Building
+
+When contributing documentation changes, ensure the documentation builds correctly. See the [docs CI workflow](https://github.com/NVIDIA/nvidia-resiliency-ext/blob/main/.github/workflows/build_docs.yml) for up-to-date instructions:
+
+   ```bash
+   pip install -U sphinx sphinx-rtd-theme sphinxcontrib-napoleon sphinx_copybutton lightning psutil defusedxml
+   sphinx-build -b html docs/source public/
+
+   # alternatively,
+   cd docs
+   make html
+   ```
+   You can then view the locally built documentation under `public` directory or `docs/build/html` (e.g., `open public/index.html`). Ensure that all documentation changes are properly formatted and that the build completes without warnings or errors.
 
 #### Signing Your Work
 

docs/source/index.rst

@@ -10,12 +10,12 @@ nvidia-resiliency-ext
 Features
 --------
 
-* `Hang detection and automatic in-job restarting <https://github.com/NVIDIA/nvidia-resiliency-ext/blob/main/docs/source/fault_tolerance/index.rst>`_
-* `In-process restarting <https://github.com/NVIDIA/nvidia-resiliency-ext/blob/main/docs/source/inprocess/index.rst>`_
-* `Async checkpointing <https://github.com/NVIDIA/nvidia-resiliency-ext/blob/main/docs/source/checkpointing/async/index.rst>`_
-* `Local checkpointing <https://github.com/NVIDIA/nvidia-resiliency-ext/blob/main/docs/source/checkpointing/local/index.rst>`_
-* `Straggler (slower ranks) detection <https://github.com/NVIDIA/nvidia-resiliency-ext/blob/main/docs/source/straggler_det/index.rst>`_
-* `Shared utilities and distributed logging <https://github.com/NVIDIA/nvidia-resiliency-ext/blob/main/docs/source/shared_utils/index.rst>`_
+* `Hang detection and automatic in-job restarting <fault_tolerance/index.html>`_
+* `In-process restarting <inprocess/index.html>`_
+* `Async checkpointing <checkpointing/async/index.html>`_
+* `Local checkpointing <checkpointing/local/index.html>`_
+* `Straggler (slower ranks) detection <straggler_det/index.html>`_
+* `Shared utilities and distributed logging <shared_utils/index.html>`_
 
 .. toctree::
    :maxdepth: 3