Files
kunail0804-ComfyUI-Scene-Co…/docs
5f2f0b7ff2 docs: overhaul repo documentation for V2 (#152)
The docs had drifted badly: docs/nodes.md still documented the Category Splitter
and Prompt Builder (removed in V1.1) and the Knowledge Base Loader (removed in
V2.1), gave the Resolver the wrong outputs, and the consistency test actively
pinned the retired RESOLVED_TAGS/CATEGORY_MAP types.

- README: rewritten around the V2 philosophy shift — 'know more, ask less'.
  Documents the automatic Knowledge Base growth, the opt-in KB-bounded semantic
  fallback and the fidelity work (know more), and the configuration
  centralization, node consolidation (eight nodes -> five) and hidden
  non-user-facing options (ask less), plus what did not change: determinism.
  Corrects the tagline (flat prompt, not category-separated) and the node tables.
- docs/nodes.md: rewritten for the five shipped nodes with their real inputs and
  outputs, plus a full Configuration input reference and the settings that are
  deliberately not exposed.
- docs/definition_of_done.md: V1 record marked complete; evidence re-pointed at
  the code as it stands (no compiler/splitter, compiler/builder).
- docs/README.md: MASTER_SPEC reframed as the original design spec (code wins);
  index the in-repo docs.
- examples/README.md: pipeline diagram redrawn for the current graph.
- tests/test_docs_consistency.py: stop requiring the retired inter-stage types and
  add a guard so removed nodes cannot reappear in the reference.

Co-authored-by: kunail0804 <kunail0804@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-19 15:11:04 +02:00
..

Documentation

Project documentation is maintained primarily in the GitHub Wiki.

MASTER_SPEC.md at the repository root is the original design specification: it records the Version 1 design intent and is kept for reference. Where it and the shipped code disagree, the code and this documentation win — V1.1 and V2 changed parts of the pipeline (see the Roadmap).

This docs/ directory holds documentation that is not part of the wiki — developer guides and generated references.

In this directory

Where to look

  • Overview & vision — wiki Overview and Vision
  • Requirements — wiki Requirements and Success Criteria
  • Architecture & pipeline — wiki Architecture and Pipeline
  • Data model & schemas — wiki Data Model, Scene JSON and Schemas
  • Knowledge Base — wiki Knowledge Base
  • Contributing — CONTRIBUTING.md