Add file-based apps reference #50371
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for file-based C# apps in .NET 10, a new feature that allows developers to create, build, and run single-file applications without traditional project files. The documentation covers directives, CLI commands, publishing options, caching, and best practices.
Key changes:
- Added complete reference documentation for file-based apps including supported directives (
#:package,#:project,#:property,#:sdk) - Documented CLI commands (
dotnet run,dotnet build,dotnet publish,dotnet pack,dotnet project convert) with examples - Included guidance on native AOT publishing, user secrets, shell execution, and folder layout recommendations
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| docs/core/sdk/file-based-apps.md | New documentation article explaining file-based apps feature for .NET 10, including directives, CLI usage, publishing, caching behavior, and best practices |
| docs/navigate/tools-diagnostics/toc.yml | Added navigation entry for the new file-based apps documentation in the SDK section |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request adds comprehensive documentation for file-based C# apps in the .NET SDK, targeting .NET 10 and later. It explains how developers can create, build, and run single-file C# applications without a traditional project file, including supported directives, CLI usage, publishing, caching, and best practices for folder layout. Additionally, the new documentation is integrated into the navigation sidebar for easy access.
Documentation addition:
docs/core/sdk/file-based-apps.md, detailing the concept, usage, supported directives, CLI commands, publishing options, caching behavior, and folder layout recommendations for file-based C# apps in .NET 10+. This includes examples and guidance for native AOT publishing, user secrets, shell execution, and handling implicit build files.Navigation update:
docs/navigate/tools-diagnostics/toc.ymlto include a link to the new "File-based apps" documentation in the SDK section, making the topic discoverable from the sidebar.Fixes #49957
Internal previews