Skip to content

@remotion/studio-protocol: Document the Studio Protocol - #9881

Merged
samohovets merged 2 commits into
studio-protocol-e2efrom
studio-protocol-docs
Jul 29, 2026
Merged

@remotion/studio-protocol: Document the Studio Protocol#9881
samohovets merged 2 commits into
studio-protocol-e2efrom
studio-protocol-docs

Conversation

@samohovets

@samohovets samohovets commented Jul 29, 2026

Copy link
Copy Markdown
Member

Summary

  • document the Remotion Studio Protocol, its public APIs, wire contract, compatibility, and security model
  • register the pages in the API table of contents, sidebar, Elements documentation, and article index
  • add generated social cards for the protocol pages
  • describe v1 as a versioned protocol for bringing reusable official Remotion Elements into Studio without promising universal third-party integration

Closes #9771.

Validation

  • cd packages/docs && bun run build-docs
  • bun run build
  • bun run stylecheck
  • git diff --check

@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated (UTC)
bugs Ready Ready Preview, Comment Jul 29, 2026 1:15pm
remotion Ready Ready Preview, Comment Jul 29, 2026 1:15pm

Request Review

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ No new issues found.

Reviewed changes — adds documentation for the @remotion/studio-protocol package, covering the protocol's public APIs, wire contract, compatibility, and security model.

  • Add six new MDX docs pages — overview (index.mdx), createElementPayload(), setStudioDragData(), installInStudio(), protocol reference, and security page
  • Register the package in the API table of contents (packages/docs/components/TableOfContents/api.tsx) and Docusaurus sidebar (packages/docs/sidebars.ts)
  • Register all six pages in the articles index (packages/docs/src/data/articles.ts) with matching compId values
  • Add generated social cards for all six pages in packages/docs/static/generated/
  • Update the Elements overview page to mention the new installation flow powered by the Studio Protocol

Pullfrog  | View workflow run | Using DeepSeek Pro (free via Pullfrog for OSS) (Claude Opus not used — the program covers this model; add its provider key to run your pick) | 𝕏

@samohovets
samohovets force-pushed the studio-protocol-docs branch from 96fc148 to bbc2586 Compare July 29, 2026 13:04
@samohovets
samohovets merged commit 611cb90 into main Jul 29, 2026
19 of 30 checks passed
@samohovets
samohovets deleted the studio-protocol-docs branch July 29, 2026 14:06
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.

@remotion/drag-and-drop: Stabilize the Element install contract

1 participant