Skip to content

Add local SDK clarification to global.json paths documentation #47673

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

Merged
merged 4 commits into from
Aug 4, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 30, 2025

This PR updates the documentation for the global.json paths property to explicitly mention that this feature enables using local SDK installations.

The current documentation explains what the paths property does technically, but doesn't clearly communicate one of its key use cases: enabling the use of SDKs that are not installed globally on the system.

cc @dotnet/appmodel @richlander

Changes Made

Added a clarifying sentence to the paths property description in docs/core/tools/global-json.md:

This feature enables using local SDK installations (such as SDKs relative to a repository root or placed in a custom folder) that are not installed globally on the system.

The sentence is positioned after the explanation of how paths are searched, providing logical flow from the technical details to the practical use case.

Impact

This change will help users who are searching for information about how to use local SDKs find this feature more easily. The existing example already demonstrates this concept with the .dotnet path, but the description now makes this use case explicit.

The change is minimal and focused, adding only one sentence without modifying any existing content or functionality.

This pull request was created as a result of the following prompt from Copilot chat.

Update the documentation for the global.json paths property in docs/core/tools/global-json.md to explicitly mention that this feature enables using 'local' SDKs. Add a note or clarifying sentence in the 'paths' property description that paths can be used to specify local SDK installations (such as SDKs checked into a repository or placed in a custom folder), which allows using SDKs that are not installed globally. This should help users searching for how to use local SDKs find this information more easily.

Reference location in the file for the update: https://github.com/dotnet/docs/blob/main/docs/core/tools/global-json.md#paths


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/core/tools/global-json.md docs/core/tools/global-json

@Copilot Copilot AI changed the title [WIP] Clarify that the 'paths' property in global.json enables using local SDKs Add local SDK clarification to global.json paths documentation Jul 30, 2025
@Copilot Copilot AI requested a review from elinor-fung July 30, 2025 20:25
Copilot finished work on behalf of elinor-fung July 30, 2025 20:25
@elinor-fung elinor-fung marked this pull request as ready for review July 30, 2025 20:32
@elinor-fung elinor-fung requested review from tdykstra and a team as code owners July 30, 2025 20:32
Copilot finished work on behalf of elinor-fung July 30, 2025 20:32
@Copilot Copilot AI requested a review from elinor-fung July 30, 2025 20:32
@Copilot Copilot AI requested a review from gewarren August 4, 2025 17:55
Copilot finished work on behalf of gewarren August 4, 2025 17:55
@gewarren gewarren merged commit 316c0c3 into main Aug 4, 2025
10 checks passed
@gewarren gewarren deleted the copilot/fix-a6deccd3-ec63-4aa0-bfd3-891a59d08a9b branch August 4, 2025 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants