Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 22, 2025

Addresses technical inaccuracies and missing clarifications in the file-based apps documentation identified during PR review.

Changes

  • Package versioning: Added note that omitting version in #:package Newtonsoft.Json requires central package management (Directory.Packages.props)

  • Argument passing: Removed incorrect guidance suggesting dotnet run file.cs arg1 arg2 passes arguments to the app (they go to dotnet run itself)

  • ResX files: Clarified ResX files are only included in non-default SDKs, not by default

  • Build cache: Removed --no-cache flag documentation as it's not needed with dotnet build file.cs

Example

Before, the package directive section didn't explain when versionless references work:

#:package Newtonsoft.Json
#:package Serilog@3.1.1

Now includes:

Note: Omitting the version number after the package name currently only works when you use central package management with a Directory.Packages.props file. Otherwise, specify the version number explicitly, or add @* after the package name to use the latest version.

Original prompt

This section details on the original issue you should resolve

<issue_title>Clarify information in file-based apps</issue_title>
<issue_description>### Type of issue

Outdated article

Description

Page URL

https://learn.microsoft.com/en-us/dotnet/core/sdk/file-based-apps

Content source URL

https://github.com/dotnet/docs/blob/main/docs/core/sdk/file-based-apps.md

Document Version Independent Id

d03da876-f782-a111-02b5-b87b2cedad11

Platform Id

bd9ae45e-1b55-0e01-0514-29c5f6c34d94

Article author

@gewarren

Metadata

  • ID: 646ac25f-6d99-4dfe-e8b3-d7de28a502ae
  • PlatformId: bd9ae45e-1b55-0e01-0514-29c5f6c34d94
  • Service: dotnet-fundamentals

Related Issues


Associated WorkItem - 540968</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.


Internal previews

📄 File 🔗 Preview link
docs/core/sdk/file-based-apps.md File-based apps

Copilot AI changed the title [WIP] Clarify information in file-based apps documentation Clarify file-based apps documentation per PR feedback Dec 22, 2025
Copilot AI requested a review from meaghanlewis December 22, 2025 23:22
Clarified notes on omitting version numbers for packages and updated default included items for file-based apps.
@meaghanlewis meaghanlewis marked this pull request as ready for review December 23, 2025 00:11
@meaghanlewis meaghanlewis requested a review from a team as a code owner December 23, 2025 00:11
Copilot AI review requested due to automatic review settings December 23, 2025 00:11
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses technical inaccuracies and missing clarifications in the file-based apps documentation based on PR review feedback. The changes improve accuracy around package versioning requirements, argument passing behavior, included file types, and build caching options.

Key changes:

  • Adds clarification that versionless package references require central package management
  • Removes incorrect documentation suggesting arguments can be passed without the -- separator
  • Clarifies that ResX files are only included by non-default SDKs

@meaghanlewis meaghanlewis merged commit 37c026f into main Dec 23, 2025
18 checks passed
@meaghanlewis meaghanlewis deleted the copilot/clarify-file-based-apps-info branch December 23, 2025 17:19
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.

Clarify information in file-based apps

3 participants