@remotion/studio-protocol: Document the Studio Protocol - #9881
Merged
Conversation
Member
Author
|
This change is part of the following stack:
Change managed by git-spice. |
This was referenced Jul 29, 2026
Contributor
There was a problem hiding this comment.
✅ 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 matchingcompIdvalues - 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
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
force-pushed
the
studio-protocol-docs
branch
from
July 29, 2026 11:28
745ad82 to
44a9a84
Compare
samohovets
force-pushed
the
studio-protocol-docs
branch
from
July 29, 2026 11:32
44a9a84 to
278ef07
Compare
samohovets
force-pushed
the
studio-protocol-docs
branch
from
July 29, 2026 11:37
278ef07 to
52058cd
Compare
samohovets
force-pushed
the
studio-protocol-docs
branch
from
July 29, 2026 11:47
52058cd to
939ec6e
Compare
samohovets
force-pushed
the
studio-protocol-docs
branch
from
July 29, 2026 11:57
939ec6e to
2053b0b
Compare
samohovets
force-pushed
the
studio-protocol-docs
branch
from
July 29, 2026 12:36
2053b0b to
f08c8a5
Compare
samohovets
force-pushed
the
studio-protocol-docs
branch
from
July 29, 2026 13:04
96fc148 to
bbc2586
Compare
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
Closes #9771.
Validation
cd packages/docs && bun run build-docsbun run buildbun run stylecheckgit diff --check