72a60aa28b
Scaffold the Phase 0 foundation per MASTER_SPEC §24:
- Directory layout: nodes/, compiler/{analyzer,validator,resolver,splitter,
builder,common}/, knowledge_base/, schemas/, prompts/, config/,
tests/{analyzer,resolver,validator,integration,regression}/, examples/,
scripts/, docs/.
- pyproject.toml targeting Python 3.11+, jsonschema as the single runtime dep,
ruff + pytest as dev deps, explicit package list, and ruff/pytest config.
- ruff for linting and formatting; pytest with repo root on pythonpath.
- GitHub Actions CI running install, ruff lint, ruff format check, and pytest
on Python 3.11 and 3.12 for pushes and pull requests.
- docs/ skeleton and CONTRIBUTING.md referencing the wiki.
- Layout test asserting the §24 structure and package importability.
Co-authored-by: kunail0804 <kunail0804@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
20 lines
808 B
Markdown
20 lines
808 B
Markdown
# Documentation
|
|
|
|
Project documentation is maintained primarily in the
|
|
[GitHub Wiki](https://github.com/kunail0804/ComfyUI-Scene-Compiler/wiki), and the
|
|
authoritative specification is [`MASTER_SPEC.md`](../MASTER_SPEC.md) at the
|
|
repository root.
|
|
|
|
This `docs/` directory holds documentation that is **not** part of the wiki —
|
|
for example design notes, developer guides, and generated references added in
|
|
later phases.
|
|
|
|
## 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)
|