#31 Update README with comprehensive docs and polished design
Pull request opened by
pingsutw
Summary
• Rewrite README for clarity, completeness, and visual appeal
• Replace emoji-heavy style with clean, professional formatting
• Add centered header with Flyte logo and badges
What changed
•
Diff-style code example showing the one-line migration
•
Comparison table — with vs without flyte-migrate
•
Full API coverage docs — every translated task param, ImageSpec field, plugin, and data type
•
ASCII architecture diagram showing the shim layer
•
Known limitations table — honest about v2 gaps
•
Examples index linking to all 14+ example files
•
Updated dev section to use
uv
(the actual toolchain)
•
Concise FAQ without noise
Test plan
• Markdown renders correctly on GitHub
• All example file links are valid
• No code changes — README only
flyteorg/flyte-migrate