Publishing the Wiki

Publishing — GitHub Repository and Separate Wiki

Important: there are two Git repositories

• Code repository: https://github.com/OWNER/REPO.git (Python source, notebook, README, diagrams, wiki/ source).
• Wiki repository: https://github.com/OWNER/REPO.wiki.git (Markdown pages displayed in the Wiki tab).

GitHub does not automatically extract ZIP uploads, nor does committing wiki/*.md in the code repo publish those pages to the separate Wiki.

Publish source code

1. Extract Distributed_Data_Parallel_Training_GitHub_Repository.zip.
2. Clone your existing repository so you keep its remote commit history: git clone https://github.com/OWNER/REPO.git.
3. Copy the contents of the extracted Distributed-Data-Parallel-Training/ folder into the clone (not the container folder itself), reviewing changes first.
4. Inspect git status, then git add ., git commit -m "Add DDP training and documentation", git push origin HEAD.

Do not force-push over existing repository changes. Inspect any .env files or datasets before staging.

Publish the Wiki with Windows CMD launcher

1. On the GitHub repository: Settings → General → Features → enable Wikis.
2. Open the Wiki tab; save an initial Home page so the .wiki.git remote exists.
3. In the extracted full-package folder, use the launcher from any working directory:

.\scripts\publish-wiki.cmd -Owner "OWNER" -Repository "REPO" -DryRun
.\scripts\publish-wiki.cmd -Owner "OWNER" -Repository "REPO"

The script clones the separate Wiki to a random temporary checkout, copies only the packaged Markdown pages, shows a diff and prompts you to type PUBLISH. It does not remove unrelated existing pages. Existing same-named pages may be replaced when you confirm. It cleans up the temporary checkout automatically.

Alternative manual Wiki publishing

git clone https://github.com/OWNER/REPO.wiki.git
cd REPO.wiki
# Copy the extracted Wiki ZIP's .md files into this folder, then:
git add -- "*.md"
git commit -m "Publish DDP Wiki with Mermaid diagrams"
git push origin HEAD

Do not use git init inside the untracked extracted ZIP directory to publish the Wiki; it is easier and safer to clone the correct remote.

Wiki address

https://github.com/OWNER/REPO/wiki

The embedded mermaid fenced blocks render in supported GitHub Markdown contexts, including Wiki pages. The separate diagram source package also contains editable .mmd files.