Fix broken doc links in README#3505
Open
hiAndrewQuinn wants to merge 1 commit into
Open
Conversation
The Runpod, Novita, and Docker setup links pointed to filenames (`runpod_setup.md`, `novita_setup.md`, `docker.md`) that do not exist. Repoint them at the actual files in `docs/` (`installation_runpod.md`, `installation_novita.md`, `installation_docker.md`). Also update the SDXL training link: the upstream sd-scripts README no longer contains an `#sdxl-training` section, so the anchor was a silent dead link. Point it at the dedicated `docs/train_SDXL-en.md` guide instead.
Author
|
Near-copy of vova-SEB's work already, whoops. I didn't think to check for open PRs on this already, I thought it was low enough hanging fruit that it would have been merged already if there were some. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Four links in
README.mdare broken or stale. This PR repoints them at the files that actually exist.docs/runpod_setup.mddocs/installation_runpod.mddocs/novita_setup.mddocs/installation_novita.mddocs/docker.mddocs/installation_docker.mdhttps://github.com/kohya-ss/sd-scripts/blob/main/README.md#sdxl-traininghttps://github.com/kohya-ss/sd-scripts/blob/main/docs/train_SDXL-en.md#sdxl-trainingsection, so the anchor silently scrolled nowhere. The dedicated SDXL guide now lives atdocs/train_SDXL-en.md.No content changes — only link targets.
Test plan
docs/installation_*.mdfiles exist in the repo.docs/train_SDXL-en.mdexists inkohya-ss/sd-scripts@mainand renders the SDXL training documentation.README.md(LICENSE.md,docs/Installation/*.md,docs/LoRA/*.md,docs/troubleshooting_tesla_v100.md,docs/train_lllite_README.md#preparing-the-dataset, GitHub URLs) still resolve.git diffis limited to the four link edits.