Skip to content

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

Merged
NeuralFault merged 4 commits into
NeuralFault:docsfrom
LykosAI:docs-review-fixups
Jul 13, 2026
Merged

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

Conversation

@mohnjiles

@mohnjiles mohnjiles commented Jul 5, 2026

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.md — MIOPEN_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
@mohnjiles @claude
docs: fix factual errors, typos, and dead links
5cd827e 
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>
@mohnjiles @claude
docs: add data directory guide and section overview pages
7706cee 
- 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>
@mohnjiles mohnjiles mentioned this pull request Jul 5, 2026
Merged
@mohnjiles @claude
Apply Gemini review: docs copyedits
84b0603 
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>
@mohnjiles mohnjiles mentioned this pull request Jul 5, 2026
Open
@mohnjiles @claude
docs: add hardware-support and troubleshooting pages
3b07583 
- 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
NeuralFault approved these changes Jul 13, 2026
View reviewed changes

@NeuralFault NeuralFault left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/advanced/hardware-support.md

**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).

@NeuralFault NeuralFault Jul 13, 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@NeuralFault NeuralFault merged commit 3bc23c1 into NeuralFault:docs Jul 13, 2026
1 check passed
@NeuralFault

NeuralFault commented Jul 13, 2026

Copy link
Copy Markdown
Owner

Also, screenshots where applicable is planned. Was intending on that being a "final phase" change once all the docs were compiled.

Thanks

@mohnjiles mohnjiles deleted the docs-review-fixups branch July 14, 2026 02:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NeuralFault NeuralFault NeuralFault approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mohnjiles @NeuralFault