Skip to content

Expose generated effect params/docs in runtime manifests#294

Open
smcga wants to merge 3 commits intomainfrom
codex/expose-and-document-generated-effect-parameters
Open

Expose generated effect params/docs in runtime manifests#294
smcga wants to merge 3 commits intomainfrom
codex/expose-and-document-generated-effect-parameters

Conversation

@smcga
Copy link
Copy Markdown
Owner

@smcga smcga commented Apr 5, 2026

Motivation

  • Generated effects from the effect-idea generator should expose UI controls and concise docs the same way built-in effects do so users can tweak generated content in the debug panel and editor.
  • Preserve and surface parameter metadata from model-generated payloads safely to ensure the editor/docs generator can include them.

Description

  • Add types for generated metadata (params and docs) and thread them through client/server types in src/effectIdeas.ts and api/effects.ts so generated payloads may carry control metadata and parameter docs.
  • Extend the generation prompt and server parsing to request, sanitize and persist params and docs (validation/trimming implemented in api/effects.ts).
  • Register approved generated effects as runtime manifests at hydration time and convert sanitized params into EffectParamControls so generated controls appear in the debug panel/editor (src/main.ts, src/renderer/effects/manifest/index.ts).
  • Update the UI submission flow to include params/docs when sending generated ideas for moderation and add a README note explaining the new behavior.

Testing

  • Ran the full test suite with npm test and all tests passed (570 tests passed across 135 files).
  • Ran docs checks with npm run docs:check and the effects/transitions docs tests passed.
  • Updated/added unit tests covering API parsing/submission (api/effects.test.ts), client generation parsing (src/effectIdeas.test.ts), and runtime-manifest registration (src/renderer/effects/manifest/index.test.ts).

Codex Task

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 5, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
codexperimental Ready Ready Preview, Comment Apr 5, 2026 4:21am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant