Skip to content
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

Merged
merged 108 commits into from
Mar 6, 2023
Merged

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented Feb 2, 2023

Initial reorganization of the sidebar! 🥳

tl/dr:

  • introduces a new Recipes section in sidebar for "guide landing pages"
  • new "All Recipes" page as a landing page for some existing examples/walkthroughs
  • shuffles pages in sidebar: fewer pages in basic (moved to guides); fewer pages in guides (moved to recipes)

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 the astro commands they will use right from the beginning, and explains the package.json scripts that are included after runningcreate-astro and how (and why) to use them.

  • OUT OF SCOPE: CLI Reference page will remain where it is, but we know we want to have "friendlier CLI content earlier, in Learn somewhere, while still being able to leave the techical descriptions of each command for Reference.

Basics:

  • Only a few pages kept here as truly "basics" you "need to know"
  • Part of the idea is to make this section look "easy to manage/get through"
  • Big Change: Astro components page - about half of the content has been removed:
    • New page "Astro Syntax" for the entire JSX-like expressions material
    • Script and style sections removed entirely as these are covered in their own pages
  • OUT OF SCOPE : rewriting Markdown/MDX to remove MDX content and KISS; re-editing Routing page to incorporate more of SSR basics/examples

Guides:

  • Some entire pages removed from sidebar (file not changed) and now linked to from "All Recipes"
  • Some pages had their long, specific examples removed and into new pages in /recipes/ for better discoverability

Recipes:

  • New section header added (also cc'd i18n-gang to ask them to contribute translations for "recipes" and "all recipes" in their languages and to PR this branch. To date, two have done so.
  • Moved all fancy/magic/landing pages HERE: CMS guides, Deploy Guides, Migrate to Astro guides, Integrations landing page
  • Created an "All Recipes" page (is it really all, if those other pages aren't here? 😅 ) which will be a landing page for longer, walk-through, guided examples so they don't have to overwhelm the other content pages. In some cases, entire pages that seem to be "how to do something" (e.g. fonts) have been moved here.
  • Edited our sidebar logic so that "All Recipes" in the sidebar is highlighted when viewing a recipe that is located in /recipes/.
  • Created a new <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.
  • Created a new <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!)
  • (NB: made a new /recipes/ folder in both public/ and /components/ to match the file structure of what goes on in the respective /tutorial/ folders in each place)
  • TO DO DONE: @delucis :
    • I assume some kind of layout/nav specific to recipes so that they include this "Back to all recipes" component (or however you choose to do this) makes sense? I have not yet attempted any kind of layout for the individual recipes (that do not show up in the sidebar) and will let you continue that!
    • Also, need to make sure existing guide pages (e.g. Fonts) show "All recipes" as highlighted when viewed. This can be done either by changing our existing logic, or moving the file (with appropriate redirect) into /recipes/ because THAT logic is working fine.
    • Obviously, edit/replace my components as necessary for the cards! Make it look nice!
    • Anything else you encounter from a UI perspective when "using" the Recipes section!

Reference Tab:

  • ENTIRELY OUT OF SCOPE

@netlify
Copy link

netlify bot commented Feb 2, 2023

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 5ec7b12
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/640670c780a3df000854b1f6
😎 Deploy Preview https://deploy-preview-2550--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@Jutanium
Copy link
Contributor

Jutanium commented Feb 2, 2023

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.

@sarah11918
Copy link
Member Author

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.)

@sarah11918 sarah11918 self-assigned this Feb 7, 2023
@sarah11918 sarah11918 added the site improvement Some thing that improves the website functionality - ask @delucis for help! label Feb 15, 2023
@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Feb 18, 2023
@delucis delucis marked this pull request as ready for review March 6, 2023 13:10
Copy link
Member

@delucis delucis left a 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.

@sarah11918 sarah11918 changed the title [reorg] initial sidebar reorg [reorg] new Recipes section; Basics streamlined Mar 6, 2023
Copy link
Member

@delucis delucis left a 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! 🚀

@sarah11918 sarah11918 added this pull request to the merge queue Mar 6, 2023
Merged via the queue into main with commit 60f35d6 Mar 6, 2023
@sarah11918 sarah11918 deleted the reorg-incl-recipes branch March 6, 2023 23:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! site improvement Some thing that improves the website functionality - ask @delucis for help!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants