Commit Graph
1 Commits
Author SHA1 Message Date
Claude 1f1db18e85 Update the README and add architecture documentation
The README still described the project as two nodes for SDXL and FLUX, told
readers to "choose either", and showed an info example predating the
architecture line. It also stated the wrong licence.

README:

- Lead with the three nodes and when to use each, rather than bolting the
  Universal loader onto a two-node description.
- Refresh the info example to a real one, including the architecture/stacks
  line, and explain every column.
- Add a Troubleshooting section covering the cases the node can now report:
  nodes missing from the menu, the mismatch warning, a LoRA that matches
  nothing, a high Other Tensors count, and divergence from the built-in
  LoraLoader.
- Note that the SDXL node also covers SD1.5 and SD2.
- Separate architectures actually verified from those supported by the same
  mechanism but not exercised, rather than implying one list.
- Correct the licence to Apache-2.0; the README claimed GPL-3.0.
- Move the changelog to CHANGELOG.md, which was 90 of the README's 250 lines.

docs/ARCHITECTURE.md is new and covers why classification runs on the canonical
target key rather than the LoRA's own names, why stack matching uses the raw
dotted key instead of the normalised one, how runtime stack discovery and the
depth axis work, and how to add an architecture or a family -- including the
widget-order compatibility contract that is easy to break silently.

Every factual claim in both documents was checked against the code: the FLUX
and SDXL block range tables, the Universal block list, the preset names, the
documented stack names against STACK_ORDER, the test count, and all internal
links and anchors.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TUT2wQ8UsjNgosRWu6jvpj
2026-07-30 11:35:59 +00:00