Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add migration guidance for icons #5443

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

mcwinter07
Copy link
Contributor

@mcwinter07 mcwinter07 commented Jan 9, 2025

Why

A small docs update for Icons following a discussion with Maicon when migrating the old icons to new ones. I've thrown a naming comparison table into the API spec for engineers that are manually migrating and also linked out to the README for the codemod sicne we have have that listed anywhere.

Note

I've chucked the Table in a collapsible cause its chonky and rolls far down the page. If we want to show the whole thing I figure we should just have a separate doc name migration guide. I don't want to sink too much time writing up additional notes so I would largely lift and shift it to a different page if folks think this would be a good idea.

Screenshot 2025-01-10 at 9 47 47 AM

What

  • Update icon (future) docs with new comparison table
  • Export the iconMap from Icon V1 codemod to use in doc stories

Copy link

changeset-bot bot commented Jan 9, 2025

🦋 Changeset detected

Latest commit: a7a0485

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@mcwinter07 mcwinter07 changed the title Kzn 2933/add migration doc update for icons Docs: Add migration guidance and additional docs for icons Jan 9, 2025
@mcwinter07 mcwinter07 changed the title Docs: Add migration guidance and additional docs for icons Docs: Add migration guidance for icons Jan 9, 2025
@mcwinter07 mcwinter07 marked this pull request as ready for review January 9, 2025 02:50
@mcwinter07 mcwinter07 requested a review from a team as a code owner January 9, 2025 02:50
@mcwinter07 mcwinter07 force-pushed the KZN-2933/add-migration-doc-update-for-icons branch from c7609c3 to 96db65b Compare January 9, 2025 02:56
Copy link
Contributor

github-actions bot commented Jan 9, 2025

✨ Here is your branch preview! ✨

Last updated for commit a7a0485: move doc to separate migration guide and add more context and notes

@mcwinter07 mcwinter07 force-pushed the KZN-2933/add-migration-doc-update-for-icons branch 2 times, most recently from cc61d89 to 864fe6d Compare January 10, 2025 01:38
dougmacknz
dougmacknz previously approved these changes Jan 10, 2025
@mcwinter07 mcwinter07 force-pushed the KZN-2933/add-migration-doc-update-for-icons branch from 864fe6d to a7a0485 Compare January 10, 2025 02:21
@mcwinter07 mcwinter07 enabled auto-merge (squash) January 10, 2025 02:32
@mcwinter07 mcwinter07 merged commit e35a71d into main Jan 10, 2025
19 checks passed
@mcwinter07 mcwinter07 deleted the KZN-2933/add-migration-doc-update-for-icons branch January 10, 2025 02:49
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