docs: guía de Studio Tools y huecos de la semana - #225
Conversation
Document the post-processing Tools panel (upscale, SeedVC revoice, rembg) against the current HTTP and worker contracts, including the unused instruction field and narrower rembg formats. Cross-link the HOWUSEIT index, README, API, and related guides; note local Music3 vs remote MiniMax and persist-before-generate song identity; record validate_local PATH inheritance and fail-closed UI steps. Co-authored-by: ignaciodelcano+dcl <ignaciodelcano+dcl@gmail.com>
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. |
Code healthQuality score: 49.9/100Higher is better. The score is a trend dashboard; the independent ratchet below remains the CI gate.
Change vs PR base: +0.0 points.
Markdown, JSON catalogs and tests are out of this table. Only Most complex functions
Trend vs baseline
Ratchet passed. |
|
Revisión independiente: sigue en draft. No retarget ni ready. La guía de Tools y la corrección de
Además, frente a Hay que reescribir esas afirmaciones (y mejor contra |
Resumen ejecutivo
Qué cambia
Documentación de operador para el panel Studio → Tools (upscale, revoice SeedVC, quitar fondo rembg), más correcciones de API/README que el código de esta semana ya tenía y las docs no.
Para qué sirve
Tools creció entre el 3 y el 5 de septiembre (PRs #129, #133 y el contrato de música) sin una HOWUSEIT. Evita que operadores e integradores asuman comportamientos que el código no hace (p. ej. que
instructioncambie el matte).Impacto para el usuario
Ninguno en runtime. Sólo docs: nueva guia, índice, README, API y notas de validación local.
Riesgo
Estado
Summary
Weekly documentation automation (cron
0 16 * * 1). Largest weakly documented surface since 2026-08-31: Studio Tools post-processing.Docs added/updated
docs/tools/HOWUSEIT.md— operator contract for upscale / SeedVC revoice / rembgdocs/HOWUSEIT.md, README first-steps + Usage + Studio audio,app/docs/API.md(revoice section, rembg constraints)docs/development/LOCAL_VALIDATION.md— UI inherits current PATH; suite stops after a failed UI stepminimax_music3, 5–300 s) vs remotemusic-2.6/music-3.0; Story song persist-before-generateCodepaths covered
POST /api/v1/tools/upscale,/revoice,/remove-backgroundapp/services/tools_upscale.py,app/shared/tools/*,app/_launch_runtime.pyTools workersui/src/components/Sidebar/ToolsPanel.tsx+useStore.runToolapp/models/TTS/minimax_music3_handler.pyduration clamp; Story song identity (docs/development/STORY_SONG_IDENTITY.md)scripts/validate_local.shPATH /set -ebehaviorKnowledge gaps addressed
instructionis stored on rembg jobs but U2Net does not consume itsource/video_pathis409workspaceis a physical output folder, not a Workspace collectionOverview
Operators open Studio → Tools, pick a source (gallery, asset catalog, upload), run one of three post-process actions, and get a new file. Jobs use the shared GPU slot, Activity footer, and
/api/v1/status//cancel. This PR only documents that path; it does not change it.Detailed changes
Backend
No runtime changes. API.md now documents revoice and the rembg instruction/format constraints already enforced by
app/routers/tools.pyandapp/_launch_runtime.py.UI and Wizard
No UI changes. The guide matches
ToolsPanel/ WizardtoolsAdapter.Data, provenance and compatibility
Documents existing sidecar lineage (
capabilityupscale/revoice/remove_background) and the physical-folderworkspacefield.Files and ownership
docs/tools/HOWUSEIT.md— new operator guidedocs/HOWUSEIT.md,docs/video-editor/HOWUSEIT.md,docs/character-kits/HOWUSEIT.md— index/cross-linksREADME.md— Tools entry, Music3, song identityapp/docs/API.md— rembg + revoice HTTP contractdocs/development/LOCAL_VALIDATION.md— PATH / fail-closed UIscheduler.md; Series Lab; LAN authValidation
python scripts/verify_clean_repo.py— PASSpython -m compileall -q app/services app/launch.py scripts— N/A (docs only)cd ui && npm run i18n:check— N/Acd ui && npm run lint -- --max-warnings=0— N/Acd ui && npm run build— N/Apython scripts/check_documentation_links.py— PASSgit diff --check— clean (committed)Code quality
main: pending CICI and review
Coste de la tarea
Notes and limitations
Claims were checked against current source.
instructionmust not be documented as steering rembg until the worker reads it. Character KitlookNotesremains UI-only / stripped.Follow-up work
lookNotesor stop sending it (code change)docs/scene-recipe-gap.mdvssceneToRecipe.tsif the serializer growsChecklist