Skip to content

docs: add migration guide section to Introduction page#142

Merged
garrity-miepub merged 2 commits intomainfrom
docs/intro-migration-guide
Mar 19, 2026
Merged

docs: add migration guide section to Introduction page#142
garrity-miepub merged 2 commits intomainfrom
docs/intro-migration-guide

Conversation

@garrity-miepub
Copy link
Copy Markdown
Contributor

@garrity-miepub garrity-miepub commented Mar 19, 2026

Add a new "Migrating Your App to MIE Web UI" section at the bottom of the Storybook Introduction page. This surfaces the execution-plan.md workflow directly in the documentation so developers and AI agents can discover the migration process without digging through the lessons/ directory.

What's Added

A new section in src/Introduction.mdx with:

  • Overview of the AI-driven migration workflow (audit → migrate → verify)
  • Visual card grid summarizing all 9 execution plan steps individually:
    1. Install @mieweb/ui
    2. CSS Foundation (brand CSS, Tailwind 4 theme, dark mode, PostCSS)
    3. Brand Switching (useBrand hook + BrandInitializer)
    4. Component Swap (Buttons → Modals → Forms → Data Display → Feedback → Nav → Overlays)
    5. Icon Migration (standardize on lucide-react)
    6. Clean Up (replace utility imports, remove unused deps, delete wrappers)
    7. Accessibility Pass (ARIA labels, keyboard nav, screen readers)
    8. Testing & Verification (visual smoke tests, build checks, compliance report)
    9. Gap Detection (document local components, flag upstream candidates)
  • Table linking to companion guides: adopting, tailwind4 integration, component policy, compliance prompt
  • Framework support note (Next.js, Vite, Remix, Meteor)

Screenshot

image

Add a new 'Migrating Your App to MIE Web UI' section at the bottom of
the Storybook Introduction page. This surfaces the execution-plan.md
workflow directly in the documentation so developers and AI agents can
discover the migration process without digging through the lessons/
directory.

The new section includes:
- Overview of the AI-driven migration workflow (audit → migrate → verify)
- Visual card grid summarizing all 9 execution plan steps:
  install, CSS foundation, brand switching, component swap,
  icon migration, cleanup, accessibility, testing, and gap detection
- Table linking to companion guides (adopting, tailwind4, component
  policy, compliance prompt)
- Note on cross-framework support (Next.js, Vite, Remix, Meteor)
Copilot AI review requested due to automatic review settings March 19, 2026 20:07
@garrity-miepub garrity-miepub marked this pull request as ready for review March 19, 2026 20:07
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new migration-focused section to the Storybook Introduction page to make the lessons/execution-plan.md workflow easier to discover for developers adopting @mieweb/ui.

Changes:

  • Introduces a “Migrating Your App to MIE Web UI” section describing the audit → migrate → verify workflow.
  • Adds a visual card grid summarizing migration steps and a table of supporting guides.
  • Documents framework support notes (Next.js, Vite, Remix, Meteor).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Change all GitHub file links from /tree/ to /blob/ so they resolve
  correctly (tree is for directories, blob for files)
- Expand the grouped 'Steps 6–9' card into 4 individual cards:
  Step 6 (Clean Up), Step 7 (Accessibility), Step 8 (Testing),
  Step 9 (Gap Detection)
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Mar 19, 2026

Deploying ui with  Cloudflare Pages  Cloudflare Pages

Latest commit: f9d3f48
Status: ✅  Deploy successful!
Preview URL: https://61c752bb.ui-6d0.pages.dev
Branch Preview URL: https://docs-intro-migration-guide.ui-6d0.pages.dev

View logs

@garrity-miepub garrity-miepub merged commit dd307e6 into main Mar 19, 2026
9 of 10 checks passed
@garrity-miepub garrity-miepub deleted the docs/intro-migration-guide branch March 19, 2026 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants