# 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 full normative
specification, maintained through Version 2. Chapters that later versions superseded
(the Category Splitter and Prompt Builder stages, the Knowledge Base Loader node) are
marked in place rather than deleted, so the original design intent stays readable
alongside what ships today.

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)