RenderPipeline2.md §11 carries the design and the normative rules, but there was nothing telling someone how to actually build and ship a package. DELIVERY_WORKFLOW.md covers the path from "QC passed" to "client has it": eligibility, building, what lands on disk, verification and its failure modes, marking delivered, and configuration. It explains hard links properly — a second name for the same data, not a copy or a shortcut — since that is the part most likely to worry someone looking at a package that appeared instantly and used no disk. Also documents the DELIVERY_BUILD stage in the worker README, which previously mentioned deliveries only in passing, and adds a documentation index to the root README. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
@@ -166,6 +166,19 @@ prisma/ — schema.prisma, seed.ts
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
| Doc | Covers |
|
||||
|---|---|
|
||||
| [RenderPipeline2.md](RenderPipeline2.md) | Render pipeline specification — normative design, state machine, API contracts |
|
||||
| [DELIVERY_WORKFLOW.md](DELIVERY_WORKFLOW.md) | Building and shipping delivery packages (how-to) |
|
||||
| [VFXReviewConnector.md](VFXReviewConnector.md) | After Effects panel — setup, Shot Builder, QC, diagnostics |
|
||||
| [RenderWorker/README.md](RenderWorker/README.md) | Render worker service — packaging, install, validation, delivery builds |
|
||||
| [EXT_API_REFERENCE.md](EXT_API_REFERENCE.md) | External API (`/api/ext/*`) used by the panel and workers |
|
||||
| [Shot task workflow.md](Shot%20task%20workflow.md) | Shot and task lifecycle in the web app |
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
Reference in New Issue
Block a user