-
-
Notifications
You must be signed in to change notification settings - Fork 531
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
Overhaul getting started guide #1026
Conversation
|
✅ Deploy Preview for astro-starlight ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
size-limit report 📦
|
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.
This looks fabulous, @delucis! Especially love the Next Steps section!
Just a few thoughts going though, but this is wonderful!
## Deploying your Starlight website | ||
|
||
Once you have created and customized your Starlight website, you can deploy it to a web server or hosting platform of your choice including Netlify, Vercel, GitHub Pages and many more. | ||
### Next steps |
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.
I LOVE these next steps!
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
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.
Wow, this is really great. So many improvements all over the place and I love the dev server/next steps sections.
The only thing that I've always found a bit confusing (at least for me as a non-native reader with my definition of theme and we may have already discussed this) is not really related to the changes, but maybe it's more obvious now, is the fact that we say "Starlight is a full-featured documentation theme" and later "Starlight is an Astro integration". Not sure if anything should be done about it, but I thought I'd mention it.
Yeah, I think this is part of the issue for ourselves of answering “What is Starlight?” 😅 I’d argue that “theme” and “integration” are not mutually exclusive and in both cases we’re drawing attention to the “built on Astro” aspect, which is important because understanding that is really helpful in knowing what else you can do with Starlight. But I still agree the messaging isn’t perfect there. (And there is also the element that you can also use Starlight without really caring about Astro, at least for basic usage.) I do think we can improve this in the first paragraph though, will make a suggestion. |
* main: (103 commits) i18n(fr): update `guides/sidebar.mdx` (withastro#1033) i18n(fr): update `reference/configuration.mdx` (withastro#1034) i18n(fr): update `reference/frontmatter.md` (withastro#1035) Fix docs component details (withastro#1031) Overhaul getting started guide (withastro#1026) i18n(zh-cn): Update sidebar.mdx & configuration.mdx (withastro#1022) i18n(es): Update `configuration` & `sidebar` (withastro#1029) [ci] format i18n(zh-cn): Update frontmatter.md (withastro#1020) i18n(zh-cn): Update overrides.md (withastro#1021) i18n(zh-cn): Update i18n.mdx (withastro#1019) fix(docs-i18n-tracker): update `translations` import (withastro#1025) [ci] format i18n(zh-cn): Update css-and-tailwind.mdx (withastro#1018) [ci] format i18n(zh-cn): Update authoring-content.md (withastro#1016) i18n(ko-KR): update `configuration.mdx` (withastro#1015) i18n(ko-KR): update `sidebar.mdx` (withastro#1014) i18n(ko-KR): update `i18n.mdx` (withastro#1013) [ci] format ...
What kind of changes does this PR include?
Description