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

[tutorial] new tutorial extensions #4876

Merged
merged 41 commits into from
Oct 15, 2023
Merged

[tutorial] new tutorial extensions #4876

merged 41 commits into from
Oct 15, 2023

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented Sep 29, 2023

What kind of changes does this PR include?

  • New or updated content

Description

This PR adds two ways to extend the existing tutorial. Both are walkthroughs starting from the existing blog tutorial codebase, but are written in a way to be more generally relevant (with caveats that if you're not using this starting code, you will need to make adjustments, and we suggest following these shorter tutorials to learn, then apply to your own project.)

  1. Moves and updates the "Migrating from File-based Routing" section on the content collections page to display a more extensive version of mostly the same content here.

Preview: https://deploy-preview-4876--astro-docs-2.netlify.app/en/extend/add-content-collections/

Screenshot 2023-10-10 11 39 02

  1. Creates a visible CTA to update the blog tutorial to View Transitions, since this is what we would like our docs to emphasize. The content here is not yet written, and honestly doesn't have to be very much because it Just Works:tm: , but will probably add some specific transitions, route announcement etc. to show these off.

Preview: https://deploy-preview-4876--astro-docs-2.netlify.app/en/extend/add-view-transitions/

Screenshot 2023-10-10 11 39 22

@netlify
Copy link

netlify bot commented Sep 29, 2023

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 87779ae
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/652c17c3521b7f0008970613
😎 Deploy Preview https://deploy-preview-4876--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 configuration.

@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. tutorial Content/UI for the Build a Blog Tutorial labels Sep 29, 2023
@jonellwood
Copy link
Contributor

jonellwood commented Oct 13, 2023

View Transitions Opening Statement has a typo in "....page transitions and animations, controling the brower’s history stack of visited pages and...."

controlling should have 2 l's and I believe it should be browsers' history with the ' after the s not before.

Aaaaand I did not see the comments above mine that already pointed this out. My apologies. Also I need to learn how to do the cool Github diff thing in these comments. lol.

These are absolutely outstanding docs! Really well done and something to be quite proud of.

Copy link
Contributor

@freekrai freekrai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good aside from that one “controling” as previously mentioned. 👍

sarah11918 and others added 2 commits October 13, 2023 10:48
Co-authored-by: Yan Thomas <[email protected]>
Co-authored-by: Yan Thomas <[email protected]>
Copy link
Contributor

@bogdaaamn bogdaaamn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left just two code suggestions, otherwise the content LGTM 🚀

src/content/docs/en/extend/add-content-collections.mdx Outdated Show resolved Hide resolved
src/content/docs/en/extend/add-content-collections.mdx Outdated Show resolved Hide resolved
src/content/docs/en/extend/add-content-collections.mdx Outdated Show resolved Hide resolved
@DarkidOP
Copy link
Contributor

Typing mistake in collections tutorial

it should prolly be "This leads to.." instead of "the*
Screenshot_20231013_195855_Chrome

Co-authored-by: Reuben Tier <[email protected]>
@cmdecker95
Copy link
Contributor

Looks pretty good!

Here's a personal reword I would implement:

Current wording

'You can instead follow these steps with your own Astro project, but you will need to adjust the instructions for your codebase.'

Suggested wording

'Alternatively, you can follow along with your own Astro project. You'll just need to adjust the instructions for your codebase.'

I'd also consider putting "Build a Blog" in quotes so that it's a little clearer that there's a distinction:

Current wording

'Build a Blog Tutorial Code

In the Build a Blog introductory tutorial...'

Suggested wording

'"Build a Blog" Tutorial Code

In the "Build a Blog" introductory tutorial...'

@leowilkin
Copy link
Contributor

Looks great. 🚀

@sarah11918 sarah11918 merged commit b101e4a into main Oct 15, 2023
10 checks passed
@sarah11918 sarah11918 deleted the more-tut branch October 15, 2023 16:56
NinuzIBZ added a commit to NinuzIBZ/docs that referenced this pull request Feb 1, 2024
The file `nav.ts` has been updated to align with the English language documentation based on this commits withastro#4876 , withastro#5183 , withastro#5213 , withastro#5271 , withastro#5187 , withastro#4667 , withastro#5541 , withastro#5605 , withastro#5499 , withastro#6470 , withastro#6620
@NinuzIBZ NinuzIBZ mentioned this pull request Feb 1, 2024
yanthomasdev added a commit that referenced this pull request Feb 5, 2024
The file `nav.ts` has been updated to align with the English language documentation based on this commits #4876 , #5183 , #5213 , #5271 , #5187 , #4667 , #5541 , #5605 , #5499 , #6470 , #6620

Co-authored-by: Yan Thomas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. tutorial Content/UI for the Build a Blog Tutorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.