Skip to content

docs: review fixups — factual corrections, link hygiene, and a few new pages#3

Open
mohnjiles wants to merge 4 commits into
NeuralFault:docsfrom
LykosAI:docs-review-fixups
Open

docs: review fixups — factual corrections, link hygiene, and a few new pages#3
mohnjiles wants to merge 4 commits into
NeuralFault:docsfrom
LykosAI:docs-review-fixups

Conversation

@mohnjiles

Copy link
Copy Markdown

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)

  • installation.md — SM auto-installs the VC++ Redistributable during package install (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).
  • environment-variables.mdMIOPEN_SEARCH_CUTOFF auto-applied value is 1, not 2 (RocmEnvironmentOptions.cs); added MIOPEN_FIND_ENFORCE=1 to 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.
  • inference/overview.md — video generation is three independent tabs (Wan Text to Video, Wan Image to Video, SVD Image to Video), each its own project type, rather than one mode.
  • supported-packages.md — ComfyUI-Zluda manual-setup cutoff aligned to "below RX 6800" per the package''s own disclaimer.
  • terminology.md — dropped the "Variable Auto Encoder" alternate name (not a real usage); reworded the "most SDXL checkpoints are VAE-baked" claim (varies a lot by release, and the broken fp16 VAE era made external VAEs near-mandatory for a while); framed the CFG ranges as community rules of thumb.
  • getting-started/overview.md — VRAM figures kept but framed as rough, dated rules of thumb since they aren''t app-enforced.

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

  • getting-started/data-directory.md — it was linked from four places, so we wrote it. Every claim is verified against SelectDataDirectoryViewModel/SettingsManager (portable .sm-portable marker and its precedence, library.json, per-OS defaults, FAT32/OneDrive warnings, and that changing the directory re-points rather than moves data).
  • package-manager/overview.md, advanced/overview.md, tips/overview.md — small section index pages so the Section Overview breadcrumbs on your existing pages resolve.
  • terminology.md also got a light wording-variety pass (reducing some repeated phrasings) — content untouched.

Left for your judgment

  • SimpleSDXL isn''t in supported-packages.md — if that''s intentional (it carries a critical known-vulnerability disclaimer in-app), all good; if you add it later, probably worth calling that out.
  • Screenshots for the getting-started/first-launch flow and a troubleshooting page would be amazing follow-ups — happy to help with either.

Thanks again for all the work on this — excited to get it upstream! 🎉

🤖 Generated with Claude Code

mohnjiles and others added 2 commits July 5, 2026 12:03
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant