What problem does it solve?
When a public Remotion API is superseded but must remain available, teams need a consistent way to mark it as deprecated across both TypeScript source code and documentation. This Skill defines the exact conventions so deprecations are represented uniformly.
Core Features & Use Cases
- TypeScript Convention: Add a JSDoc
@deprecated annotation on the public symbol, stating the replacement API and linking to its documentation.
- Documentation Convention: Apply double-tilde strikethrough to the API's heading while keeping
<AvailableFrom> outside it, and add an info admonition named Deprecated directly after the heading.
- Scope Guidance: Clarifies that runtime warnings, sidebar badges, release notes, and removal behavior are not part of the deprecation convention, and that removed APIs fall outside it.
- Use Case: When replacing
oldApi() with newApi(), use this Skill to annotate the old export with @deprecated and update its docs page with a struck-through heading and a deprecation admonition pointing to the replacement.
Quick Start
Use the deprecate-api skill to mark the oldApi function as deprecated in the TypeScript source and update its documentation page to point users to newApi.
