seed-deprecation

Manages deprecation lifecycle for components, tokens, and APIs with versioned notices and migration docs.

1.1k|89|Updated Mar 11, 2021
One-click install
npx skills add https://github.com/daangn/seed-design --skill seed-deprecation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: seed-deprecation
Source: https://github.com/daangn/seed-design/tree/main/skills/seed-deprecation
Command: npx skills add https://github.com/daangn/seed-design --skill seed-deprecation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Deprecating a component, prop, or design token in a design system requires touching many files at once: JSDoc annotations, Rootage YAML specs, documentation pages, and a central deprecation tracker. This Skill standardizes that entire lifecycle so version numbers, replacement guidance, and removal schedules stay consistent everywhere.

Core Features & Use Cases

  • Standardized deprecation notices: Adds JSDoc @deprecated tags to TypeScript/TSX code and @deprecated notes to Rootage YAML specs with reason, removal version, and replacement.
  • Documentation synchronization: Updates design guidelines, React docs, and the central deprecations.mdx migration tracker with matching version information.
  • Removal tracking: Guides the final cleanup when the removal version arrives, including regenerating Rootage artifacts and moving entries to the history section.
  • Use Case: You want to deprecate the rounded prop on a button component in favor of borderRadius="r2". The Skill walks you through annotating the code, updating the YAML spec, documenting the migration path, and scheduling removal in the next major release.

Quick Start

Ask the assistant to deprecate a specific component prop or token, providing the target, current version, removal version, replacement, and reason.

Frequently Asked Questions about seed-deprecation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deprecate a component prop in a design system?

Add a JSDoc @deprecated tag to the TypeScript code stating the deprecation version, removal version, replacement, and reason. Then update the Rootage YAML spec, documentation pages, and the central deprecations.mdx tracker with the same information.

What information is required to deprecate an API option?

Five inputs are required: the target (component, option, or token), the version where deprecation is declared, the planned removal version, the replacement to use instead, and the reason for deprecation. Missing inputs are requested in that order.

When are deprecated items actually removed in SEED Design?

Deprecated items are declared in minor or patch releases and removed only in the next major release starting from version 2.0.0. Legacy 1.x releases allowed removal in minor versions.

Does deprecating a Rootage token require regenerating files?

Yes. When Rootage YAML specs change, run bun run rootage:generate to regenerate artifacts such as docs/public/rootage, packages/css/vars, and packages/qvism-preset/src/vars so generated output matches the spec.

What happens when the removal version for a deprecated item arrives?

The deprecated target is deleted from code and specs, documentation, examples, and tests are cleaned up, and the entry in deprecations.mdx is moved to the history section to complete the lifecycle.