-
-
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
streamlined install plus develop and build pages #10060
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
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.
combines installation instructions for examples/templates in basic CLI wizard instructions
I think I’m missing a “why” here. I find it a bit confusing to combine these in a step by step guide: if scanning quickly, do I also need to run these? if I already ran the first command and now realise wanted one of the other ones, what do I do?
takes the content that was cut to form a "develop and build" page for those who want more guidance on e.g. starting the dev server, building and previewing
I like this page!
I believe Erika is adding an --add flag
Certainly wouldn’t add more to these steps. If anything that tells me to have subsections below for “Use a custom template”, “Add integrations” etc.
So some of my thinking here:
We could have a section for installation flags for customizing installation. (add integrations, use a particular theme/starter example) |
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.
LGTM! Just a nit regarding the "Install dependencies" step. But I guess pnpm add astro
works too.
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
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.
A few nits here, but overall LGTM
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Description (required)
Attempts to make a sleeker "getting started" path!
Notably:
For review:
the PackageManagerTabs now show multiple commands, so I've separated out the basic one (for copy paste reasons) from the others that can't be used copy paste anyway. Are we cool with this?
I believe Erika is adding an
--add
flag for the command to runastro add
with integrations upon project creation. Will happily add this to the blocks too!did not rename
install-and-setup.mdx
and therefore no redirect at this time. But we could rename to e.g.installation.mdx
and therefore would need a redirect.Note:
nav.ts
entry because I expect the new sidebar to be merged before this PR, so we won't need it! Will update sidebar entries after merging.