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

[DX] Remove Create new Vite project section from docs #2976

Open
2 of 3 tasks
Baroshem opened this issue Sep 12, 2023 · 6 comments
Open
2 of 3 tasks

[DX] Remove Create new Vite project section from docs #2976

Baroshem opened this issue Sep 12, 2023 · 6 comments
Assignees

Comments

@Baroshem
Copy link
Contributor

Provide a description of requested docs changes

Hey there!

I was just looking at the docs and I would like to recommend a DX improvement to the documentation.

In the Vue section of the documentation, User can select one of three supported frameworks, namely Nuxt 3, Vite and Astro as following.

image

My problem is that in case of Nuxt and Astro, the instructions start from the point to explain user how to add Storefront UI to existing project, while for Vite the instruction start from creating a new project.

I was a bit confused about it and at first I didnt know what to do. Does this mean that I cannot add Storefront UI for existing Vite project?

If there is no strict rule to have this create new vite project section, I would recommend to remove it to maintain consistency across frameworks and shorten the way (and confusion) of setting Storefront UI in Vite projects :)

Able to fix / change the documentation?

  • Yes
  • No

Code of Conduct

  • I agree to follow this project's Code of Conduct
@FRSgit
Copy link
Contributor

FRSgit commented Sep 15, 2023

Hey @Baroshem - it seems like a valuable feedback for our documentation. Though I see that our Nuxt video guide actually starts with creating new Nuxt project, so maybe we should point to the create nuxt app also in written docs.

Don't know how to answer the question: Does this mean that I cannot add Storefront UI for existing Vite project?
For me personally it's understandable from the docs that it's possible - you just need to skip the first step of the guide. I'm not sure what to do here: for sure it would be good having similar guidelines (starting from the same point) for every framework.
@mattmaribojoc @skirianov can you look into this one?

@skirianov
Copy link

@FRSgit we can add 1 step as optional and put a note that if you have a project already you can skip this step, but imo it's not neeeded and it's clear that if you have project, you can add it on top. wdyt @mattmaribojoc?

Also, our Next install docs start from creating a fresh new app too

@FRSgit FRSgit assigned FRSgit and skirianov and unassigned FRSgit Sep 18, 2023
@Szymon-dziewonski
Copy link
Contributor

Hello @skirianov, what is status here? do you have any update in this topic?
@mattmaribojoc maybe you would have some suggestions, what should we do here? Thank you both for contributing :)

@mattmaribojoc
Copy link
Contributor

@FRSgit Removing or making it an optional step sounds good to me - since the other Vue ones don't have project initializations steps, I'd personally just remove.

@FRSgit
Copy link
Contributor

FRSgit commented Oct 4, 2023

Okay, sounds good! Could you change it please? You can file PR directly against v2 branch - let's get it into the documentation and close this topic 😄

@filrak
Copy link
Collaborator

filrak commented Dec 25, 2023

@skirianov what is the status here, imho we shouldn't instruct how to set up new project and assume it's there already.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants