Agent skill · writing content · remotion-dev
deprecate-api
Reference for how deprecation of public Remotion APIs is represented in TypeScript source and documentation. Use when adding, reviewing, or discussing a deprecation of a function, component, hook, type, prop, option, or other public API that remains available.
Why this skill is useful
Codifies specific conventions for deprecating APIs in TypeScript and documentation, which the AI could infer but now doesn't have to guess.
What it needs
About 1k tokens when loaded. Last updated 2026-08-06. 55,698 stars on the source repository.
What this skill does
API deprecations in Remotion Deprecation of a public API that remains available is represented in three places: 1. A JSDoc @deprecated annotation on the public TypeScript API. 2. Strikethrough formatting on the API's documentation heading. 3. An info admonition named Deprecated directly after that heading. These conventions apply to functions, components, hooks, types, props, options, and other public APIs. TypeScript representation The public symbol carries a JSDoc @deprecated annotation. The annotation states the replacement when one exists and may link to its documentation. The annotation belongs where consumers receive it. For a re-export or compatibility alias, this is the exported symbol rather than the non-deprecated implementation. Documentation representation The deprecated API name in its heading uses double-tilde strikethrough. <AvailableFrom> remains outside the strikethrough. For a prop or option: The frontmatter title remains unchanged. A page that otherwise relies only on its frontmatter title has an explicit struck-through heading. An info admonition named Deprecated appears directly after the heading and points to the replacement when one exists. Scope Runtime warnings, sidebar badges, release notes, removal versions, and removal behavior are not currently standardized as part of API deprecation. Removed APIs are outside this convention. They may remain documented for migration purposes, but they no longer have a public symbol to annotate.
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills remotion-dev/deprecate-api