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

Migration guide polish and examples #10889

Merged
merged 26 commits into from
Oct 5, 2023
Merged

Conversation

sophschneider
Copy link
Contributor

@sophschneider sophschneider commented Oct 5, 2023

Fixes #10806

  1. Added support for <details> toggles on markdown
  2. Added support for collabsibleTOC pages (off by default) so you can quickly skip to the section you need. This isn't perfect yet (doesn't auto open when linking directly to an anchor) but is much better than what we currently have
  3. Organized v11 to v12 styleguide into consistent steps
  4. Put regex validation, mapping tables, and examples in details toggles to make the page less overwhelming and put migration commands at the forefront
  5. Added introduction, glossary, and generalized the migration workflow section. Put these at the top to introduce builders to the migration
  6. Added descriptive titles to all component migrations naming what they do
  7. Added examples to each component migration and removed them from the "Whats new" page
  8. Added regex validation snippets to all component migrations
  9. Added alert text for stepped migrations that have to be run in order
  10. Cleaned up copy and overall improved migration experience giving more context on how and why we are running the migrations. Aimed to make it clear enough that an intern could run a migration on their code base
  11. Add padding to code blocks

toc-demo

Screen Recording 2023-10-05 at 3 09 18 PM

@sophschneider sophschneider force-pushed the sophie/migration-guide-styles branch 3 times, most recently from 0c79f1a to 69b8b99 Compare October 5, 2023 16:43
@sophschneider sophschneider marked this pull request as ready for review October 5, 2023 19:20
Co-authored-by: Lo Kim <lo.kim@shopify.com>
Co-authored-by: Lo Kim <lo.kim@shopify.com>
Copy link
Contributor

@laurkim laurkim left a comment

Choose a reason for hiding this comment

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

💯 🌟 🚀

sophschneider and others added 2 commits October 5, 2023 17:43
Co-authored-by: Lo Kim <lo.kim@shopify.com>
@sophschneider sophschneider merged commit e8fab65 into next Oct 5, 2023
7 checks passed
@sophschneider sophschneider deleted the sophie/migration-guide-styles branch October 5, 2023 22:11
mrcthms pushed a commit that referenced this pull request Oct 12, 2023
Fixes #10806

1. Added support for `<details>` toggles on markdown
2. Added support for `collabsibleTOC` pages (off by default) so you can
quickly skip to the section you need. This isn't perfect yet (doesn't
auto open when linking directly to an anchor) but is much better than
what we currently have
3. Organized v11 to v12 styleguide into consistent steps
4. Put regex validation, mapping tables, and examples in details toggles
to make the page less overwhelming and put migration commands at the
forefront
5. Added introduction, glossary, and generalized the migration workflow
section. Put these at the top to introduce builders to the migration
6. Added descriptive titles to all component migrations naming what they
do
7. Added examples to each component migration and removed them from the
"Whats new" page
8. Added regex validation snippets to all component migrations
9. Added alert text for stepped migrations that have to be run in order
10. Cleaned up copy and overall improved migration experience giving
more context on how and why we are running the migrations. Aimed to make
it clear enough that an intern could run a migration on their code base
11. Add padding to code blocks


![toc-demo](https://github.com/Shopify/polaris/assets/20652326/c1b012b6-b576-405f-a69e-f7cc085d66f2)

![Screen Recording 2023-10-05 at 3 09 18
PM](https://github.com/Shopify/polaris/assets/20652326/4999bcbe-960b-4718-ba73-04963eeed302)

---------

Co-authored-by: Lo Kim <lo.kim@shopify.com>
mrcthms pushed a commit that referenced this pull request Oct 12, 2023
Fixes #10806

1. Added support for `<details>` toggles on markdown
2. Added support for `collabsibleTOC` pages (off by default) so you can
quickly skip to the section you need. This isn't perfect yet (doesn't
auto open when linking directly to an anchor) but is much better than
what we currently have
3. Organized v11 to v12 styleguide into consistent steps
4. Put regex validation, mapping tables, and examples in details toggles
to make the page less overwhelming and put migration commands at the
forefront
5. Added introduction, glossary, and generalized the migration workflow
section. Put these at the top to introduce builders to the migration
6. Added descriptive titles to all component migrations naming what they
do
7. Added examples to each component migration and removed them from the
"Whats new" page
8. Added regex validation snippets to all component migrations
9. Added alert text for stepped migrations that have to be run in order
10. Cleaned up copy and overall improved migration experience giving
more context on how and why we are running the migrations. Aimed to make
it clear enough that an intern could run a migration on their code base
11. Add padding to code blocks


![toc-demo](https://github.com/Shopify/polaris/assets/20652326/c1b012b6-b576-405f-a69e-f7cc085d66f2)

![Screen Recording 2023-10-05 at 3 09 18
PM](https://github.com/Shopify/polaris/assets/20652326/4999bcbe-960b-4718-ba73-04963eeed302)

---------

Co-authored-by: Lo Kim <lo.kim@shopify.com>
AnnaCheba pushed a commit to AnnaCheba/polaris that referenced this pull request Apr 22, 2024
Fixes Shopify#10806

1. Added support for `<details>` toggles on markdown
2. Added support for `collabsibleTOC` pages (off by default) so you can
quickly skip to the section you need. This isn't perfect yet (doesn't
auto open when linking directly to an anchor) but is much better than
what we currently have
3. Organized v11 to v12 styleguide into consistent steps
4. Put regex validation, mapping tables, and examples in details toggles
to make the page less overwhelming and put migration commands at the
forefront
5. Added introduction, glossary, and generalized the migration workflow
section. Put these at the top to introduce builders to the migration
6. Added descriptive titles to all component migrations naming what they
do
7. Added examples to each component migration and removed them from the
"Whats new" page
8. Added regex validation snippets to all component migrations
9. Added alert text for stepped migrations that have to be run in order
10. Cleaned up copy and overall improved migration experience giving
more context on how and why we are running the migrations. Aimed to make
it clear enough that an intern could run a migration on their code base
11. Add padding to code blocks


![toc-demo](https://github.com/Shopify/polaris/assets/20652326/c1b012b6-b576-405f-a69e-f7cc085d66f2)

![Screen Recording 2023-10-05 at 3 09 18
PM](https://github.com/Shopify/polaris/assets/20652326/4999bcbe-960b-4718-ba73-04963eeed302)

---------

Co-authored-by: Lo Kim <lo.kim@shopify.com>
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.

3 participants