Skip to content

docs: document Character Kits, Face Rig, and cutout dialogue - #94

Merged
IAnMove merged 3 commits into
mainfrom
docs/character-kits-guide
Sep 2, 2026
Merged

docs: document Character Kits, Face Rig, and cutout dialogue#94
IAnMove merged 3 commits into
mainfrom
docs/character-kits-guide

Conversation

@IAnMove

@IAnMove IAnMove commented Sep 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • rescue and update the useful Character Kits / Face Rig / cutout-dialogue guidance from historical PR docs: Character Kits, Face Rig, and cutout dialogue #26
  • document the real Character Kit HTTP routes, CAS revision contract, approval gates, persistent sources, mouth/eye states, cleanup, Recipe inventory, and dialogue cadence
  • distinguish physical Output folders from logical Workspace collections and fix stale HocusPocus/Loreframe wording in the touched guides
  • record current Scene → Recipe serializer status and Director pagination behavior

Validation

  • python - <<'PY' ... touched-doc local links + anchors: PASS (7 documents)
  • python scripts/check_documentation_links.py: PASS
  • python scripts/verify_clean_repo.py: PASS
  • python scripts/check_brand_contract.py: PASS
  • uv run --with pytest python -m pytest -q tests/test_character_kit_library.py: 7 passed
  • git diff --check: PASS

The 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 fetched main and 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.md covering 2D puppets, CAS library writes, approval gates, Face Rig cleanup, cutout dialogueBeats, and Recipe inventory. app/docs/API.md gains 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 workspace query) 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/pipelines limit/offset pagination (Workspaces tab pages 8) is documented. docs/scene-recipe-gap.md notes that ui/src/lib/sceneToRecipe.ts now exists so the old “no serializer” claim is historical.

Reviewed by Cursor Bugbot for commit 263a730. Configure here.

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

PR Review — Loreframe Studio

Risk: low
Scope: 7 file(s); +500/-38; docs

Automated review from scripts/analyze_pr.py. This is a heuristic pass (no LLM) so humans still own the merge decision.

Findings

  • No heuristic issues. Still run the CI checklist below.

Changed files

  • added: docs/character-kits/HOWUSEIT.md
  • modified: README.md, app/docs/API.md, docs/3d-video-compositor/HOWUSEIT.md, docs/HOWUSEIT.md, docs/scene-recipe-gap.md, docs/workspaces/HOWUSEIT.md

CONTRIBUTING checklist

  • python scripts/verify_clean_repo.py
  • python -m compileall -q app/services app/launch.py scripts
  • cd ui && npm run build if the UI changed
  • No weights, CivitAI sidecars, or generated guides
  • Stays local-first (no required accounts / telemetry)

Posted by the repo PR review workflow. Re-runs on each push to the PR.

@IAnMove

IAnMove commented Sep 2, 2026

Copy link
Copy Markdown
Owner Author

cursor review

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ 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.

@IAnMove
IAnMove merged commit c3f4d7d into main Sep 2, 2026
4 checks passed
@IAnMove
IAnMove deleted the docs/character-kits-guide branch September 5, 2026 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant