docs icon indicating copy to clipboard operation
docs copied to clipboard

[doc] Add a caution callout in the blog tutorial to ease the beginner experience

Open ealch opened this issue 1 year ago • 3 comments

Description

In this change, additional callout were added to the blog tutorial to enhance clarity and understanding for users following the provided instructions. The comments were added to emphasize the importance of including the expanded class on the Navigation component's div.

Why? This was done to assist users in identifying and addressing potential issues if they are not seeing the expected changes in the user interface after implementing the styles provided in the tutorial.

Related issues & labels (optional)

  • Suggested label: docs

First-time contributor to Astro Docs?

Yes! doWhile#6572

ealch avatar May 25 '24 16:05 ealch

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

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview May 25, 2024 4:58pm

vercel[bot] avatar May 25 '24 16:05 vercel[bot]

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes. If they spot any broken links you will see some error messages on this PR. Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Vercel 🥳

  3. One or more of our maintainers will take a look and may ask you to make changes. We try to be responsive, but don’t worry if this takes a few days.

astrobot-houston avatar May 25 '24 16:05 astrobot-houston

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en tutorial/3-components/3.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

astrobot-houston avatar May 25 '24 16:05 astrobot-houston

Yes, as @at-the-vr mentioned, we do not add notes reminding people of things they've been told to do in a tutorial. It's assumed that they have followed instructions, and if they haven't then they have to go back and make sure they have! Otherwise, the entire tutorial could be full of notes saying, "remember to do the thing in the instruction."

So, I'll be closing this PR, but thank you for wanting to make the tutorial experience better for everyone!

sarah11918 avatar Jun 14 '24 19:06 sarah11918