# Documentation

Project documentation is maintained primarily in the
[GitHub Wiki](https://github.com/kunail0804/ComfyUI-Scene-Compiler/wiki).

[`MASTER_SPEC.md`](../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](https://github.com/kunail0804/ComfyUI-Scene-Compiler/wiki/Roadmap)).

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

## In this directory

- [`nodes.md`](nodes.md) — the ComfyUI node reference (inputs, outputs, types).
- [`knowledge_base_build.md`](knowledge_base_build.md) — how the Knowledge Base is regenerated.
- [`benchmarks.md`](benchmarks.md) — performance baselines.
- [`definition_of_done.md`](definition_of_done.md) — the Version 1 completion record.

## 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`](../CONTRIBUTING.md)