add local docs

Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com>

Author: sirutBuasai

docs/DEVELOPMENT.md

@@ -239,6 +239,46 @@ cd docs && mkdocs serve
 
 ______________________________________________________________________
 
+## Local Documentation Development
+
+### Generation Only (No Server)
+
+Run `main.py` to generate documentation without serving:
+
+```bash
+cd docs/src && python main.py --verbose
+```
+
+This automatically clones `tutorials/` repository and generates markdown files in `reference/` and `releasenotes/` directories without starting a web server.
+
+### Serving Locally
+
+Use `mkdocs serve` to automatically clone `tutorials/` generate documentation in `reference/` and `releasenotes/` and serve the website:
+
+```bash
+cd docs && mkdocs serve
+```
+
+The site is typically available at `http://127.0.0.1:8000/deep-learning-containers/` - check the command output for the actual URL.
+
+### Live Reload
+
+Enable automatic reload on content changes:
+
+```bash
+mkdocs serve --livereload
+```
+
+**Note:** Live reload only detects changes to:
+
+- Markdown file content
+- `.nav.yml` content
+- `mkdocs.yml` content
+
+Live reload does **not** detect changes requiring documentation regeneration (e.g., image config YAML files, templates). To regenerate documentation, stop the server (`Ctrl+C`) and rerun `mkdocs serve`.
+
+______________________________________________________________________
+
 ## Troubleshooting
 
 | Error | Solution |

docs/src/data/template/image-template.yml

@@ -6,7 +6,7 @@
 # =============================================================================
 
 # -----------------------------------------------------------------------------
-# Required Fields
+# Common Fields
 # -----------------------------------------------------------------------------
 
 # Framework display name (e.g., "PyTorch", "TensorFlow")
@@ -18,9 +18,6 @@ version: "2.9"
 # Accelerator type: gpu, cpu, or neuronx
 accelerator: gpu
 
-# Python version identifier (e.g., py310, py311, py312)
-python: py312
-
 # Target platform: ec2 or sagemaker
 platform: ec2
 
@@ -37,6 +34,9 @@ tags:
 # For example, if you require a column called "foo",
 # add foo field here and in your desired table YAML file.
 
+# Python version identifier (e.g., py310, py311, py312)
+python: py312
+
 # CUDA version identifier (for GPU images)
 cuda: cu130
 

docs/src/utils.py

@@ -85,6 +85,11 @@ def parse_version(version_str: str | None) -> Version:
 def clone_git_repository(git_repository: str, target_dir: str | Path) -> None:
     """Clone a git repository to target directory if it doesn't exist."""
     if os.path.exists(target_dir):
+        LOGGER.info(
+            f"{git_repository} already exists within {target_dir}"
+            "If you want to pull the latest commit of the repository, either delete the repository and re-run generation"
+            f"or manually run `git pull` within the {target_dir}"
+        )
         return
     subprocess.run(["git", "clone", "--depth", "1", git_repository, target_dir], check=True)