skills.rest
adobe
adobeOFFICIAL
Explore all skills by this author →
WebsiteGitHub

consumer-migration-guide

Generate per-component consumer migration guides in MDX for Spectrum 1-to-2 upgrades.

1.5k|257|Updated Nov 19, 2018
Search Tags:#automation#documentation#migration#mdx#spectrum#consumers#component-upgrade
One-click install
npx skills add https://github.com/adobe/spectrum-web-components --skill consumer-migration-guide
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: consumer-migration-guide
Source: https://github.com/adobe/spectrum-web-components/tree/main/.ai/skills/consumer-migration-guide
Command: npx skills add https://github.com/adobe/spectrum-web-components --skill consumer-migration-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps teams create consistent, consumer-facing migration guides for upgrading from Spectrum 1 Web Components to Spectrum 2 components.

Core Features & Use Cases

  • Generate per-component migration guides in MDX that document public API changes and rollout considerations.
  • Align guidance with Spectrum 1 and Spectrum 2 sources to ensure accuracy.
  • Output is concise, consumer-focused, and ready to publish alongside the Spectrum 2 component.

Quick Start

Create a consumer migration guide for a component by following the prompt and saving it as 2nd-gen/packages/swc/components/[component-name]/consumer-migration-guide.mdx.

Frequently Asked Questions about consumer-migration-guide

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

FAQPage Schema
How do I generate a Spectrum component migration guide for consumers?▼

Generate a Spectrum component migration guide by creating an MDX file that documents public API changes, accessibility, styling, and a checklist for upgrading from Spectrum 1 to Spectrum 2 components.

What sections are required in a Spectrum 2 consumer migration guide MDX file?▼

A consumer migration guide MDX file requires sections for What changed, Update your code, Accessibility, Styling, and Checklist to document public API changes accurately.

How do I automate documentation for Spectrum 1-to-2 component upgrades?▼

Automate documentation for Spectrum 1-to-2 component upgrades by applying an MDX template to each valid component, generating a consumer-focused migration guide that aligns with Spectrum source materials.

Does the Spectrum migration guide template verify API changes against source components?▼

The Spectrum migration guide template verifies claims against Spectrum 1 and Spectrum 2 sources to ensure the generated consumer documentation accurately reflects public API changes.

Can I use this MDX migration guide generator for non-Spectrum component upgrades?▼

This MDX migration guide generator is specifically designed for Spectrum 1-to-2 component upgrades, enforcing the required MDX structure and verifying claims against Spectrum source materials.

Where should the generated consumer migration guide MDX file be saved?▼

The generated consumer migration guide MDX file should be saved as consumer-migration-guide.mdx within the 2nd-gen/packages/swc/components/[component-name]/ directory structure.

Related Skills

Explore More Software Engineering Skills→
adobecomadobecom

react-spectrum-s2

Provide accessible React Spectrum S2 UI components for React projects.

Official
Basic
machenjiemachenjie
4

sdk-library-contract-design

Design SDK and library contracts to minimize breaking upgrades across semver.

Community
Advanced
EndavaEndava
160

review-doc

Audit BEEQ documentation pages against repository documentation rules.

Official
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced