-
-
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
[reorg] new Recipes section; Basics streamlined #2550
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
This is super exciting! Use UI Frameworks stands out in the recipes section, as it's the only one that is formatted like a comprehensive guide/explainer and not a step-by-step how-to. I think using UI frameworks is integral enough to Astro that it could go in the Basics section and isn't something we'd want to push down far in the nav. |
Will think about this! We'll have to have more discussions about whether UI Frameworks are in fact "basics" because they are something that has to be installed. And, you don't need to know/use UI Frameworks, they are an add-on. In first discussions with Fred they were still in guides, but I wondered about moving them into recipes for discoverability. But you're right about them feeling maybe out of place in recipes? (In fact, the Markdown AND MDX page is going to become just markdown, for a similar reason. But, since all I had done is edit the sidebar and not content in my first iteration, it still is the Markdown and MDX page.) |
Co-authored-by: Yan Thomas <[email protected]>
Co-authored-by: Dan Jutan <[email protected]>
Co-authored-by: Yan Thomas <[email protected]>
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.
These changes are super positive! Already feels like such an organisational improvement as well as giving us scope to grow in exciting ways.
Mentioned on Discord that I’d suggest pulling @Jutanium’s big new recipes about forms into a separate dedicated PR to give us time and space to review those independently.
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 think this PR pot’s been bubbling long enough and these recipes are ready to serve! 🚀
Initial reorganization of the sidebar! 🥳
tl/dr:
This PR attempts to make the content of the Learn sidebar sections "a good length" so as not to be overwhelming.
Getting Started:
The CLI reference page has been renamed and moved here. Also, the introduction has been re-written for a "getting started" audience to introduce theastro
commands they will use right from the beginning, and explains thepackage.json
scripts that are included after runningcreate-astro
and how (and why) to use them.Basics:
Guides:
/recipes/
for better discoverabilityRecipes:
/recipes/
.<RecipeBox />
card component (based on the<Box/>
we use in the tutorial) with its own svg icon to display the recipes. @delucis , go wild! I at least gave you a standalone component to work from.<BackToRecipes />
component based on our current page navigation cards and tested it by throwing it on the "All Recipes" page (which does NOT need this component!)/recipes/
folder in bothpublic/
and/components/
to match the file structure of what goes on in the respective/tutorial/
folders in each place)TO DODONE: @delucis :/recipes/
because THAT logic is working fine.Reference Tab: