cloudflare-docs icon indicating copy to clipboard operation
cloudflare-docs copied to clipboard

Update get-started.mdx

Open swarajbachu opened this issue 1 year ago β€’ 1 comments

the previous command wasnt actually creating it to the framework as next, changing the tag is initializing the next project

Summary

the command was about starting a new next project, but it is instead just running to create a normal project

Screenshots (optional)

previous

Screenshot 2024-08-20 at 8 35 44β€―PM

swarajbachu avatar Aug 20 '24 15:08 swarajbachu

hello @IgorMinar can you look into this once

swarajbachu avatar Aug 23 '24 15:08 swarajbachu

Thanks for the PR @swarajbachu πŸ™‚

Could you please update your PR to use the PacakgeManager starlight component (see starlight-package-managers) we're now using across the docs?

Something like:

<PackageManagers type="create" pkg="cloudflare@latest" args="--framework=next" />

That will make sure that we do get the right command for the various package managers πŸ™‚

PS: if you could apply the change also to all the other guides under src/content/docs/pages/framework-guides that would be really really appreciated! 😁 🫢

dario-piotrowicz avatar Sep 04 '24 22:09 dario-piotrowicz

sure, lemme do that

swarajbachu avatar Sep 04 '24 23:09 swarajbachu

starlight-package-managers

just one thing to note is that this means it will appear this way

npm create cloudflare@latest -- --framework=next

instead of

npm create cloudflare@latest my-next-app -- --framework=next

or I can do

<PackageManagers type="create" pkg="cloudflare@latest my-next-app" args="--framework=next" />

but it doesn't seem to be a good practice

so for now I am doing the way you told me to do, lemme know if you need to change it further

swarajbachu avatar Sep 05 '24 00:09 swarajbachu

@dario-piotrowicz updated the way you mentioned for now

swarajbachu avatar Sep 05 '24 01:09 swarajbachu

@swarajbachu thanks so much for updating the guides, it's really very much appreciated!

As you pointed out in your comment my suggestion wasn't actually fully correct (I did it on the spot as an example without checking things too much, sorry for the confusion)

I think that the right change would then be:

<PackageManagers
	type="create"
	pkg="cloudflare@latest"
	args="my-next-app --framework=next"
/>

This does seem to produce the correct results: Screenshot 2024-09-05 at 12 30 38 Screenshot 2024-09-05 at 12 30 45

and it's not, as far as I can tell, bad practice or anything like that.

What do you think? could you make this one last change? (to all the guides as well πŸ˜…) πŸ™

dario-piotrowicz avatar Sep 05 '24 10:09 dario-piotrowicz

@swarajbachu thanks so much for updating the guides, it's really very much appreciated!

As you pointed out in your comment my suggestion wasn't actually fully correct (I did it on the spot as an example without checking things too much, sorry for the confusion)

I think that the right change would then be:

<PackageManagers
	type="create"
	pkg="cloudflare@latest"
	args="my-next-app --framework=next"
/>

This does seem to produce the correct results: Screenshot 2024-09-05 at 12 30 38 Screenshot 2024-09-05 at 12 30 45

and it's not, as far as I can tell, bad practice or anything like that.

What do you think? could you make this one last change? (to all the guides as well πŸ˜…) πŸ™

hmm yeah cool, now I am will do that, and do you want me to also add bun?

swarajbachu avatar Sep 05 '24 11:09 swarajbachu

hmm yeah cool, now I am will do that

@swarajbachu thanks a lot! ❀️

and do you want me to also add bun?

I'm not sure πŸ˜• (I guess it depends how much extra code that would entail)

I'd avoid that for now, the best person to ask would be @KianNH, but he's currently on holiday I believe

I'm not sure if Kian has already considered/looked into bun, to avoid delays with merging this PR I would just avoid adding bun and potentially think of such addition as a followup πŸ™‚

dario-piotrowicz avatar Sep 05 '24 12:09 dario-piotrowicz

hmm yeah cool, now I am will do that

@swarajbachu thanks a lot! ❀️

and do you want me to also add bun?

I'm not sure πŸ˜• (I guess it depends how much extra code that would entail)

I'd avoid that for now, the best person to ask would be @KianNH, but he's currently on holiday I believe

I'm not sure if Kian has already considered/looked into bun, to avoid delays with merging this PR I would just avoid adding bun and potentially think of such addition as a followup πŸ™‚

cool lemme do the remaining changes then

swarajbachu avatar Sep 05 '24 13:09 swarajbachu

@dario-piotrowicz done dude

swarajbachu avatar Sep 05 '24 15:09 swarajbachu

hello dude @dario-piotrowicz

swarajbachu avatar Sep 06 '24 13:09 swarajbachu

@swarajbachu sorry I was unable to review the PR yesterday πŸ™‡, I'm having a look right now πŸ™‚

dario-piotrowicz avatar Sep 06 '24 16:09 dario-piotrowicz

Fantastic job @swarajbachu, thanks so very much for the various updates! 🫢

I've left a few comments for things that need amending, besides these small changes it looks great to me πŸ˜„

Thanks for the contribution, @swarajbachu, I'll merge as soon as checks pass. Definitely appreciate the help here making sure other folks don't run into the issue you experienced.

kodster28 avatar Sep 06 '24 17:09 kodster28

Congratulations @swarajbachu, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cm0qzwju811720cjqvvwfw1h5

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account. Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

holopin-bot[bot] avatar Sep 06 '24 17:09 holopin-bot[bot]