docs: document Character Kits, Face Rig, and cutout dialogue - #94
Merged
Conversation
PR Review — Loreframe StudioRisk: low Automated review from Findings
Changed files
CONTRIBUTING checklist
Posted by the repo PR review workflow. Re-runs on each push to the PR. |
Owner
Author
|
cursor review |
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no new issues!
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit 263a730. Configure here.
This was referenced Sep 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
python - <<'PY' ...touched-doc local links + anchors: PASS (7 documents)python scripts/check_documentation_links.py: PASSpython scripts/verify_clean_repo.py: PASSpython scripts/check_brand_contract.py: PASSuv run --with pytest python -m pytest -q tests/test_character_kit_library.py: 7 passedgit diff --check: PASSThe UI Character Kit test was not run because this isolated clone has no
ui/node_modules; no UI code is changed. This PR is based on the latest fetchedmainand does not close or merge historical PR #26.Note
Low Risk
Markdown and API reference updates only; no runtime, auth, or data-handling code changes.
Overview
This PR is documentation-only: it documents Character Kits / Face Rig / cutout dialogue and aligns operator guides with current product terminology and APIs.
New and expanded guides: Adds
docs/character-kits/HOWUSEIT.mdcovering 2D puppets, CAS library writes, approval gates, Face Rig cleanup, cutoutdialogueBeats, and Recipe inventory.app/docs/API.mdgains a matching Character Kits HTTP section; the README and 3D Video compositor guide link Character Creator handoff and compositor usage into that doc.Terminology: Across README and HOWUSEIT files, physical output folders (legacy
workspacequery) are distinguished from logical Workspace collections (/api/v1/workspace-collections). Stale Loreframe Lab naming is replaced with HocusPocus where touched.Other corrections: Director
GET /api/v1/director/pipelineslimit/offsetpagination (Workspaces tab pages 8) is documented.docs/scene-recipe-gap.mdnotes thatui/src/lib/sceneToRecipe.tsnow exists so the old “no serializer” claim is historical.Reviewed by Cursor Bugbot for commit 263a730. Configure here.