Skip to main content
Agent skill

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.

Get started

Get the complete skill folder, including its scripts and reference files.

When to use this skill

Use Deprecate Api when an AI agent needs a reusable SKILL.md workflow for this job: 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.

When not to use it

Skip Deprecate Api when the task is outside the coding category, or when a more specific skill in this directory already covers the same workflow with clearer triggers.

How to install

Where will you use it?

Install scope
Claude Code folder setup
mkdir -p ~/.claude/skills/deprecate-api
# Save SKILL.md to ~/.claude/skills/deprecate-api/SKILL.md
  1. Claude Code personal install: place the skill and its bundled files at ~/.claude/skills/deprecate-api/SKILL.md. For a shared project, commit the folder at .claude/skills/deprecate-api/ instead.
  2. Current Claude Code detects SKILL.md changes in watched directories during the session. If you just created a top-level skills directory, run /reload-skills. Check that the skill is listed before testing its trigger.
  3. For Claude chat or Cowork in the Desktop app, manage uploaded skills in Customize > Skills; copying files into a local Claude Code folder is not a Desktop install. Other agents may use different install locations.

Full install guide for Claude, Cursor, and Codex →

Try a starter prompt

After installing the skill, paste this starter prompt into your agent to verify it triggers on a small task.

Starter prompt
Use the Deprecate Api skill for this task: Use Deprecate Api when this documented workflow matches the task. Confirm any required inputs or files before making changes.

What supports this recommendation?

70/100 provisional content score. This measures documentation, practical detail and source signals. It is not a measured task success rate or a security certification.

Documentation
77/100
Practical detail
68/100
Source evidence
63/100
Source signals
70/100
Model compatibility evidence
  • claudeuntested

    No model-specific signal or recorded compatibility test was found.

  • chatgptuntested

    No model-specific signal or recorded compatibility test was found.

  • geminiuntested

    No model-specific signal or recorded compatibility test was found.

  • copilotuntested

    No model-specific signal or recorded compatibility test was found.

  • llamauntested

    No model-specific signal or recorded compatibility test was found.

  • perplexityuntested

    No model-specific signal or recorded compatibility test was found.

  • mistraluntested

    No model-specific signal or recorded compatibility test was found.

  • grokuntested

    No model-specific signal or recorded compatibility test was found.

Inferred compatibility is based on content signals. Check the app, its available tools and setup requirements before running a skill.

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.

```ts /** * @deprecated Use `newApi()` instead: https://www.remotion.dev/docs/new-api */ export const oldApi = () => {}; ```

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.

```mdx # ~~oldApi()~~<AvailableFrom v="4.0.0" /> ```

For a prop or option:

```mdx ### ~~`oldOption?`~~ ```

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.

```mdx :::info Deprecated Use [`newApi()`](/docs/new-api) instead. ::: ```

## 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.

Intended uses

  • Use Deprecate Api when this documented workflow matches the task.

Implementation notes

  • Review the source instructions and adapt inputs before running the workflow.

Try it, then tell us how it went

A copied prompt does not tell us whether the task worked. Report your result after checking the output. We collect your tool and outcome, never your files or prompt.