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

The documentation should also have npm commands #16265

Closed
nbro opened this issue May 16, 2024 · 1 comment
Closed

The documentation should also have npm commands #16265

nbro opened this issue May 16, 2024 · 1 comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals.

Comments

@nbro
Copy link

nbro commented May 16, 2024

Sylius docs version:1.13.1

Description

The Sylius documentation uses yarn to run the JS/Node related commands, but yarn is not installed by default when you install node. So, I think the default commands should use npm instead of yarn or, at least, both options should be in the documentation.

@GSadee GSadee added the Documentation Documentation related issues and PRs - requests, fixes, proposals. label May 17, 2024
@GSadee
Copy link
Member

GSadee commented May 17, 2024

Hi @nbro!

Thank you for opening an issue with such a suggestion.

We are currently using yarn in the documentation, and we also have a mention that it is needed. So I would suggest leaving it as it is and adding an additional note with information about npm that this can be used instead. Feel free to contribute to our documentation, and as this is not a significant issue, I am closing it 🖖🏻

@GSadee GSadee closed this as completed May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals.
Projects
None yet
Development

No branches or pull requests

2 participants