docs: review fixups — factual corrections, link hygiene, and a few new pages - #3
Merged
Merged
Conversation
Fact-checked the docs against the current codebase and fixed: - installation.md: VC++ Redistributable is auto-installed by SM during package install (WindowsPrerequisiteHelper); manual install reframed as a troubleshooting fallback - environment-variables.md: MIOPEN_SEARCH_CUTOFF auto-applied value is 1 (not 2); added MIOPEN_FIND_ENFORCE=1 to the auto-applied list; clarified RDNA3/RDNA3.5/RDNA4 gating incl. gfx1152/gfx1153 AOTriton exclusion; noted ComfyUI-Zluda's own auto-set vars and that the env-var editor overrides auto-applied defaults - inference/overview.md: video generation is three independent tabs (Wan T2V, Wan I2V, SVD I2V), not one mode; removed self-referential breadcrumb - supported-packages.md: ComfyUI-Zluda manual-setup cutoff is RX 6800 (matches the package's own disclaimer) - terminology.md: removed incorrect "Variable Auto Encoder" alternate name; corrected the "most SDXL checkpoints are VAE-baked" overclaim; framed CFG ranges as community rules of thumb; reduced repetitive phrasing throughout (wording only, no content changes) - overview.md: softened VRAM figures as dated rules of thumb - Converted links to not-yet-written pages into plain text with (planned) markers so nothing 404s; fixed typos (documentation, explanation, packages, Integration) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- getting-started/data-directory.md: what lives in the library folder, default locations per OS, portable mode (.sm-portable marker and precedence), changing it later (re-points, does not move data), and the FAT32/OneDrive warnings. All claims verified against SelectDataDirectoryViewModel, SettingsManager, and Compat. - package-manager/overview.md, advanced/overview.md, tips/overview.md: short section index pages so the "Section Overview" breadcrumbs on existing pages resolve; planned pages listed unlinked. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
a/an agreement, missing colon + comma splice, duplicate "needed", GB's -> GBs, worfklows -> workflows, missing periods, 16GB -> 16 GB. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- advanced/hardware-support.md: per-backend GPU support breakdown (CUDA incl. legacy/driver caveats, Windows AMD trichotomy of ROCm preview/ZLUDA/DirectML with gfx-arch gating, Linux ROCm, IPEX, MPS, CPU), all claims verified against BasePackage/WindowsRocmSupport/ GpuInfo/package classes; anchors #amd-rocm and #apple-silicon-mps preserved for existing references - troubleshooting/common-issues.md: symptom-first fixes for the recurring issue classes from the GitHub tracker (install failures, launch/update breakage, GPU/backend mismatches, Linux/macOS quirks, CivitAI browser, Inference connection/extension errors), plus log locations and bug-reporting guidance; app-behavior claims verified in code, known bugs flagged honestly instead of given fake fixes - README + advanced overview link the new pages Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
NeuralFault
approved these changes
Jul 13, 2026
NeuralFault
left a comment
Owner
There was a problem hiding this comment.
LGTM
Just had a note on a line in hardware support file that can be improved at a later time.
Caught some good typing errors of mine also :)
With it merged, can speed up additional pages and I can send directly to upstream as I have many locally on my end that are not expanded upon yet.
| **What Stability Matrix does automatically:** | ||
| - When a supported AMD GPU is present on Windows, ROCm becomes the recommended backend for ROCm-capable packages (currently ComfyUI and Comfy-based flows via SwarmUI). |
There was a problem hiding this comment.
Should this list also the other packages supported with ROCm handling in Windows? ( Reforge, Wan2GP, InvokeAI).
Better yet, a section in supported-packages.md dedicated for Windows ROCm capable packages and link to that? Having a table there for that would be better i think and just link to that section.
This can be merged as-is for the time being and modified later if that is added.
Uh oh!
There was an error while loading. Please reload this page.
NeuralFault
commented
Jul 13, 2026
Owner
Also, screenshots where applicable is planned. Was intending on that being a "final phase" change once all the docs were compiled. Thanks |
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Hey! First off — this docs branch is seriously impressive work. We fact-checked it against the codebase and the vast majority held up, including stuff that''s genuinely hard to get right (the ComfyUI API/WebSocket details and the Inference panel-layout descriptions are 100% accurate, and the ROCm section clearly came from reading the actual source). We''d love to get this merged into the main repo, so here''s a fixup PR to help get it over the line rather than a wall of review comments. Feel free to push back on anything!
Factual corrections (verified against source)
WindowsPrerequisiteHelper.InstallVcRedistIfNecessary), so the manual install is now framed as a troubleshooting fallback rather than the norm (kept your c10.dll symptom detail — that''s useful).MIOPEN_SEARCH_CUTOFFauto-applied value is1, not2(RocmEnvironmentOptions.cs); addedMIOPEN_FIND_ENFORCE=1to the auto-applied list; the "(RDNA3 and newer)" notes now spell out RDNA3/RDNA3.5/RDNA4 and the gfx1152/gfx1153 AOTriton exclusion; added a note about ComfyUI-Zluda''s own auto-set vars and that env-var editor entries are applied last.Link hygiene
Links to not-yet-written pages are now plain text with (planned) markers so readers don''t hit 404s, and they''re easy to re-link as you write each page. Typo fixes in the README intro and a couple of other spots (documentation/explanation/packages/Integration).
New pages
SelectDataDirectoryViewModel/SettingsManager(portable.sm-portablemarker and its precedence,library.json, per-OS defaults, FAT32/OneDrive warnings, and that changing the directory re-points rather than moves data).Section Overviewbreadcrumbs on your existing pages resolve.Left for your judgment
Thanks again for all the work on this — excited to get it upstream! 🎉
🤖 Generated with Claude Code