Deprecation Workflow

Deprecating patterns is a natural part of design system evolution. UiPool helps you track deprecated pattern usage, notify teams, and ensure smooth migrations to new patterns.

To deprecate a pattern in UiPool:

1. 1Navigate to the pattern you want to deprecate
2. 2Click the ⋮ menu and select Edit pattern
3. 3Enable the Deprecated toggle
4. 4Add migration guidance in the documentation field

You can also indicate deprecation directly in your code comments:

// uipool-pattern: old-modal @deprecated
// Use dialog-modal instead
export function OldModal({ children }) {
  // Legacy implementation
  return <div className="old-modal">{children}</div>;
}

The scanner will flag this pattern as deprecated in the report, even if it hasn't been marked in the dashboard yet.

Once a pattern is deprecated, UiPool helps you track where it's still being used:

• Pattern detail page — Shows which projects are still using the deprecated pattern
• Scan reports — Deprecated patterns are highlighted with warnings
• CI/CD reports — PR comments include deprecated pattern warnings

Help teams migrate away from deprecated patterns by providing clear guidance:

## Migration Guide: old-modal → dialog-modal

This pattern is deprecated as of v2.0. Please migrate to dialog-modal.

### Why?
- Better accessibility (focus trapping, ARIA)
- Consistent animation API
- Smaller bundle size

### Migration Steps
1. Replace OldModal with DialogModal
2. Update the 'onClose' prop to 'onDismiss'
3. Wrap content in DialogContent component

### Before
<OldModal onClose={handleClose}>...</OldModal>

### After  
<DialogModal onDismiss={handleClose}>
  <DialogContent>...</DialogContent>
</DialogModal>

Best practices for migration documentation:

• ✓Link to the replacement pattern
• ✓Explain why the pattern was deprecated
• ✓Provide before/after code examples
• ✓Set a target date for complete migration

A typical deprecation workflow follows these phases:

Once all usage has been migrated, you can safely delete the pattern:

1. 1. Verify the pattern shows 0 projects in Usage Analytics
2. 2. Click the ⋮ menu and select Delete pattern
3. 3. Type the pattern slug to confirm deletion