Skip to content

Use awesome Steps component in tutorial#7496

Merged
sarah11918 merged 9 commits into
withastro:mainfrom
liruifengv:steps-tutorial
Mar 25, 2024
Merged

Use awesome Steps component in tutorial#7496
sarah11918 merged 9 commits into
withastro:mainfrom
liruifengv:steps-tutorial

Conversation

@liruifengv
Copy link
Copy Markdown
Member

@liruifengv liruifengv commented Mar 20, 2024

Description (required)

Use awesome Steps component in our blog tutorial

Related issues & labels (optional)

  • Closes #
  • Suggested label:

@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 20, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Mar 25, 2024 6:31pm

@liruifengv liruifengv added the consistency/formatting Standardizing without changing docs content e.g. indenting, lists etc. label Mar 20, 2024
casungo
casungo reviewed Mar 20, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@casungo casungo left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I left some comments with screenshots to mark some places where the steps may not be used correctly, but other than that the change is very appreciated and looks very polished!

Comment thread src/content/docs/en/tutorial/1-setup/2.mdx
Comment thread src/content/docs/en/tutorial/5-astro-api/2.mdx
Comment thread src/content/docs/en/tutorial/5-astro-api/3.mdx
Comment thread src/content/docs/en/tutorial/5-astro-api/3.mdx
Comment thread src/content/docs/en/tutorial/6-islands/2.mdx
@liruifengv
Copy link
Copy Markdown
Member Author

liruifengv commented Mar 20, 2024

Thanks for your review @casungo Do you have any good ideas for a list with only one item?

morinokami
morinokami reviewed Mar 20, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@morinokami morinokami left a comment

Choose a reason for hiding this comment

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

I think we can add Steps to the following sections as well:

IMHO, while it may not be strictly correct to use the Steps component for a single step, since this doesn't technically constitute multiple 'steps', I believe it is still acceptable. Maintaining consistency in using the Steps component, even for a single step, should help users understand that this is an instruction they should follow.

@casungo
Copy link
Copy Markdown
Contributor

casungo commented Mar 20, 2024

Thanks for your review @casungo Do you have any good ideas for a list with only one item?

I don't really know. Maybe it's acceptable as @morinokami said. I think we have to wait on more people and see different perspectives :)

VoxelMC
VoxelMC reviewed Mar 20, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@VoxelMC VoxelMC left a comment

Choose a reason for hiding this comment

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

Pretty nifty work! The Steps component really brings the visuals to the next level! Thank you for taking on this job (emphasis on job).

I have left a few of my opinions, I hope they help! :)

Comment thread src/content/docs/en/tutorial/1-setup/2.mdx Outdated
Comment thread src/content/docs/en/tutorial/2-pages/2.mdx Outdated
Comment thread src/content/docs/en/tutorial/2-pages/3.mdx
Comment thread src/content/docs/en/tutorial/2-pages/4.mdx
Comment thread src/content/docs/en/tutorial/4-layouts/1.mdx
Comment thread src/content/docs/en/tutorial/6-islands/1.mdx
@liruifengv
Copy link
Copy Markdown
Member Author

liruifengv commented Mar 21, 2024

I think we can add Steps to the following sections as well:

Done

@liruifengv
Copy link
Copy Markdown
Member Author

liruifengv commented Mar 21, 2024

To summarise the problem:

  • How to deal with only one listitem in page.
  • Only one listitem in Box
    image
  • The listitem in the page are all in order. See: 1aae53c

@sarah11918
Copy link
Copy Markdown
Member

sarah11918 commented Mar 21, 2024

Resolved all the outstanding issues on Talking and Doc'ing!

In summary, yes, one item lists are good! (They call out when you have to do something.)

And yes, even one item lists in a box are good! (same reasoning).

at-the-vr
at-the-vr approved these changes Mar 21, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@at-the-vr at-the-vr left a comment

Choose a reason for hiding this comment

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

I was in T&D 😄 + love the changes LGTM 👍

@Fryuni
Copy link
Copy Markdown
Member

Fryuni commented Mar 21, 2024

I listened to it happening! It sounded nice, hahaha

mingjunlu
mingjunlu approved these changes Mar 21, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@mingjunlu mingjunlu left a comment

Choose a reason for hiding this comment

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

LGTM! Nice work everyone 👏

sarah11918
sarah11918 approved these changes Mar 21, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

We ALL approve! Talking and Doc'ing says LGTM! Thank you for this amazing PR, @liruifengv !

@sarah11918 sarah11918 added site improvement Some thing that improves the website functionality - ask @delucis for help! Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! labels Mar 21, 2024
@liruifengv
Copy link
Copy Markdown
Member Author

liruifengv commented Mar 21, 2024

Thank you everyone!💗

casungo
casungo approved these changes Mar 21, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@casungo casungo left a comment

Choose a reason for hiding this comment

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

Couldn't be present at this Talking and Doc'ing sadly.
LGTM :)

@sarah11918
Copy link
Copy Markdown
Member

sarah11918 commented Mar 22, 2024

!coauthor

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 22, 2024 

Co-authored-by: casungo <casungo@outlook.it>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Luiz Ferraz <luiz@lferraz.com>
Co-authored-by: Shinya Fujino <shf0811@gmail.com>
Co-authored-by: voxel!() <voxelmc@hotmail.com>
Co-authored-by: Ming-jun Lu <40516784+mingjunlu@users.noreply.github.com>
Co-authored-by: Atharva <2021peb5208@mnit.ac.in>

@sarah11918 sarah11918 merged commit f519527 into withastro:main Mar 25, 2024
@huyikai huyikai mentioned this pull request Mar 26, 2024
Merged
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Mar 26, 2024
@thomasbnt
i18n(fr): Update files edited by <Steps> empire from withastro#7496
db4c637
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Mar 26, 2024
@thomasbnt
i18n(fr): Update files edited by <Steps> empire from withastro#7496
49ab48a
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Mar 26, 2024
@thomasbnt
i18n(fr): Update files edited by <Steps> empire from withastro#7496
e38a4ea
thomasbnt added a commit to thomasbnt/docs that referenced this pull request Mar 26, 2024
@thomasbnt
i18n(fr): Update files edited by <Steps> empire from withastro#7496
05c5cab
@thomasbnt thomasbnt mentioned this pull request Mar 26, 2024
Merged
This was referenced Mar 26, 2024
Closed
Closed
Closed
Closed
Closed
Closed
Merged
Merged
@Liumingxun Liumingxun mentioned this pull request Mar 27, 2024
Closed
@jsparkdev jsparkdev mentioned this pull request Mar 27, 2024
Merged
dreyfus92 added a commit that referenced this pull request Mar 28, 2024
@thomasbnt @HiDeoo @dreyfus92
i18n(fr): Update files with <Steps> component (#7586)
2dec2ef 
* i18n(fr): Update files edited by `<Steps>` empire from #7496

* i18n(fr): Update files edited by `<Steps>` empire from #7496

* i18n(fr): Update files edited by `<Steps>` empire from #7496

* i18n(fr): Update files edited by `<Steps>` empire from #7496

* i18n(fr): Fix err typo

* i18n(fr): Renaming title `tutorial/2-pages/3.mdx`

* i18n(fr): Err tab

* i18n(fr): Err tab

* i18n(fr): Fix tab

Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>

* i18n(fr): Fix tab

Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>

* i18n(fr): Add `<Steps>` in add-view-transitions.mdx

Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>

---------

Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>
Co-authored-by: HiDeoo <494699+hideoo@users.noreply.github.com>
Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
@mearashadowfax mearashadowfax mentioned this pull request Mar 30, 2024
Merged
This was referenced Mar 31, 2024
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@morinokami morinokami morinokami left review comments

@sarah11918 sarah11918 sarah11918 approved these changes

@mingjunlu mingjunlu mingjunlu approved these changes

+3 more reviewers

@VoxelMC VoxelMC VoxelMC left review comments

@casungo casungo casungo approved these changes

@at-the-vr at-the-vr at-the-vr approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

consistency/formatting Standardizing without changing docs content e.g. indenting, lists etc. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! site improvement Some thing that improves the website functionality - ask @delucis for help!

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@liruifengv @casungo @sarah11918 @Fryuni @morinokami @VoxelMC @mingjunlu @at-the-vr