Skip to content

docs(configuration/settings) - updated globalFolder documentation #6821

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

vincentmughal11
Copy link

What's the problem this PR addresses?

The globalFolder config in the Yarn settings documentation is shown with a value that appears to represent the default, but it's actually just an example. This may lead to confusion, where on platforms like Windows the actual default is different (%LOCALAPPDATA%\Yarn\Berry) - just to make things clear.

Closes #6814

How did you fix it?

Clarified in the documentation that the value shown for globalFolder is only an example and not the acutal platform-specific default.

I updated the Settings (packages/docusaurus/static/configuration/yarnrc.json) documentation file to clarify that the value shown for settings like globalFolder are example values adn not necessarily platform defaults. This helps revent confusion, especially for Windows users, where the default global folder is different than the one shown.

  • I edited the respective JSON file in the packages/docusaurus/static/configuration directory
  • I followed contribution guidelines and verified the changes using yarn start to preview the updated documentation.

image

Checklist

  • I have set the packages that need to be released for my changes to be effective.
  • I will check that all automated PR checks pass before the PR gets reviewed.

@vincentmughal11 vincentmughal11 changed the title updated globalFolder documentation docs(configuration/settings) - updated globalFolder documentation Jun 13, 2025
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

Successfully merging this pull request may close these issues.

[Bug?]: globalFolder is not ${HOME}/.yarn/berry on Windows as documented
1 participant