-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Add note about having to run astro build
before astro preview
#5604
Add note about having to run astro build
before astro preview
#5604
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Hello! Thank you for opening your first PR to Astro’s Docs! 🎉 Here’s what will happen next:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this contribution, @hirasso ! We appreciate you taking the time to add some helpful content for the next person! 🙌
I have edited the format of your content to be more in line with the rest of our docs. We rarely add notes, which are for tangential information, and almost never add cautions which are for truly alarming/security issues to watch out for.
We prefer to incorporate important content into the main text itself, instead of new content being "oh, and another thing!" or "Oh, and note this!" This makes for a better reading experience, and if it's important content, it should be said right the first time.
I've reviewed our documentation both on astro build
and astro preview
and added a bit of extra context right in the description to show that preview
is meant to be used in conjunction with build
. Rather than a scary warning message, I have linked the two together.
I do think this is helpful extra context to have, and we are happy you contributed it! Welcome to Team Docs! 🥳
Hi Sarah! Thanks for your help with this. Appreciate it! After reading through the updated text, I must confess that I would still not understand that |
As an aside note: very interesting to read your thoughts about when to use a note/caution. I just plain love the Astro docs! ❤️ |
Hi @hirasso, See what you think now! I tried to add a little bit more context in both the opening line and the next paragraph. |
@sarah11918 now it's much more clear! Ready to be merged I'd say 😊 |
…mdx` (#6363) * i18n(fr) Update reading-time.mdx Just for translator tracker because the PR #5766 should have been [ignore] * Update astro-pages.mdx * Update framework-components.mdx * Update layouts.mdx * Update routing.mdx * Update editor-setup.mdx * Update configuring-astro.mdx * Update cloudflare.mdx * Update deno.mdx * Update netlify.mdx * Update vercel.mdx * Update imports.mdx * Update auto.mdx * Update manual.mdx * Update cli-reference.mdx Update and del some parts * Update cli-reference.mdx Update fiule with PR #5512 #5651 #5604 #5765 #6040 #6043 #6109 #6267 * Update auto.mdx * Update cloudflare.mdx fix PR #5284 * Update markdown-content.mdx * Update auto.mdx * Update src/content/docs/fr/core-concepts/astro-pages.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/astro-pages.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/astro-pages.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/framework-components.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/framework-components.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/guides/markdown-content.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/install/manual.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/install/manual.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/reference/cli-reference.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
…mdx` (#6363) * i18n(fr) Update reading-time.mdx Just for translator tracker because the PR #5766 should have been [ignore] * Update astro-pages.mdx * Update framework-components.mdx * Update layouts.mdx * Update routing.mdx * Update editor-setup.mdx * Update configuring-astro.mdx * Update cloudflare.mdx * Update deno.mdx * Update netlify.mdx * Update vercel.mdx * Update imports.mdx * Update auto.mdx * Update manual.mdx * Update cli-reference.mdx Update and del some parts * Update cli-reference.mdx Update fiule with PR #5512 #5651 #5604 #5765 #6040 #6043 #6109 #6267 * Update auto.mdx * Update cloudflare.mdx fix PR #5284 * Update markdown-content.mdx * Update auto.mdx * Update src/content/docs/fr/core-concepts/astro-pages.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/astro-pages.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/astro-pages.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/framework-components.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/framework-components.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/guides/markdown-content.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/install/manual.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/install/manual.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/reference/cli-reference.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
Description (required)
Yesterday I got bitten by not having completely understood that
astro preview
doesn't automaticallybuild
the project. This PR adds acaution
box to save others some time:Related issues & labels (optional)
astro preview
fails silently with missingdist
folder astro#9297