Skip to content

Commit 0f7e5cd

Browse files
Merge pull request #48017 from dotnet/main
Merge main into live
2 parents f1313e8 + a90eb81 commit 0f7e5cd

File tree

141 files changed

+863
-255
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

141 files changed

+863
-255
lines changed

.github/copilot-instructions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
11
# .NET Documentation Guidelines
22

3+
## Disclosure
4+
5+
For any Markdown files generated by AI, always disclose that they were created with the assistance of AI. Add the following frontmatter key/value pair:
6+
7+
```markdown
8+
ai-usage: ai-generated
9+
```
10+
311
## Terminology
12+
413
- Unless otherwise specified, all .NET content refers to modern .NET (not .NET Framework).
514

615
## Writing Style
16+
717
Follow [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) with these specifics:
818

919
### Voice and Tone
20+
1021
- Active voice, second person addressing reader directly.
1122
- Conversational tone with contractions.
1223
- Present tense for instructions/descriptions.
@@ -16,6 +27,7 @@ Follow [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-g
1627
- Avoid "we"/"our" referring to documentation authors or product teams.
1728

1829
### Structure and Format
30+
1931
- Sentence case headings (no gerunds in titles).
2032
- Be concise, break up long sentences.
2133
- Oxford comma in lists.
@@ -26,13 +38,15 @@ Follow [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-g
2638
- No consecutive headings without content between them.
2739

2840
### Formatting Conventions
41+
2942
- **Bold** for UI elements.
3043
- `Code style` for file names, folders, custom types, non-localizable text.
3144
- Raw URLs in angle brackets.
3245
- Use relative links for files in this repo.
3346
- Remove `https://learn.microsoft.com/en-us` from learn.microsoft.com links.
3447

3548
## API References
49+
3650
Use cross-references: `<xref:api-doc-ID>`.
3751

3852
To find API doc IDs:
@@ -43,6 +57,7 @@ To find API doc IDs:
4357
If unsure, use API browser: `https://learn.microsoft.com/api/apibrowser/dotnet/search?api-version=0.2&locale=en-us&search={API_NAME}&$skip=0&$top=5` and then use the `url` value from the results as a manual link.
4458

4559
## Code Snippets
60+
4661
For snippets >6 lines:
4762
1. Create `./snippets/my-doc/language` folder in same directory as document (for a document named `my-doc.md`) where language is either vb (for visual basic) or csharp (for c#). Omit the `language` component when the document is in the `docs/visual-basic`, `docs/csharp`, or `docs/fsharp` folders.
4863
1. Add snippet as separate code file.
@@ -52,8 +67,10 @@ For snippets >6 lines:
5267
1. When you add code, use code comments sparingly because they don't get localized. You can use them to briefly clarify code-specific details (such as logic, parameters, or edge cases). Put any critical information and context in the markdown text of the referencing article.
5368

5469
## File Naming
70+
5571
New Markdown files: lowercase with hyphens, omit filler words (the, a, etc.).
5672

5773
## Special Cases
74+
5875
- Breaking changes: Include directions from `.github/prompts/breaking-change.md`.
5976
- When you (Copilot) are assigned an issue in GitHub, after you've completed your work and the workflows (status checks) have run, check to make sure there are no build warnings under the OpenPublishing.Build status check. If there are, open the build report (under View Details) and resolve any build warnings you introduced.

docfx.json

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -835,7 +835,7 @@
835835
"_csharplang/proposals/csharp-14.0/null-conditional-assignment.md": "This proposal allows the null conditional operator to be used for the destination of assignment expressions. This allows you to assign a value to a property or field only if the left side is not null.",
836836
"_csharplang/proposals/csharp-14.0/extensions.md": "This proposal enables new kinds of extension members. These new extension members support extension properties, extension static members, including extension operators.",
837837
"_csharplang/proposals/csharp-14.0/user-defined-compound-assignment.md": "This proposal introduces user-defined compound assignment operators. Developers can override compound assignment, increment, and decrement operators.",
838-
"_csharplang/proposals/csharp-14.0/ignored-directives.md": "This proposal allows a source file to include ignored directives. In most cases, ignored directives are used for file based programs, for example `#!`",
838+
"_csharplang/proposals/csharp-14.0/ignored-directives.md": "This proposal allows a source file to include ignored directives. In most cases, ignored directives are used for file-based apps, for example `#!`",
839839
"_csharplang/proposals/csharp-14.0/extension-operators.md": "This proposal extends the proposal for extensions to include *extension operators*, where an operator can be an extension member.",
840840
"_csharplang/proposals/csharp-14.0/named-and-optional-parameters-in-expression-trees.md": "This proposal allows an expression tree to include named and optional parameters. This enables expression trees to be more flexible in how they are constructed.",
841841
"_roslyn/docs/compilers/CSharp/Compiler Breaking Changes - DotNet 7.md": "Learn about any breaking changes since the initial release of C# 10 and included in C# 11",
@@ -902,20 +902,25 @@
902902
"open_to_public_contributors": {
903903
"docs/standard/design-guidelines/**.md": false
904904
},
905-
"ms.custom": {
906-
"docs/framework/**/*.md": "UpdateFrequency5",
907-
"docs/visual-basic/**/*.md": "UpdateFrequency5"
908-
},
909905
"ms.collection": {
910-
"docs/ai/**/**.md": "ce-skilling-ai-copilot",
911-
"docs/ai/**/**.yml": "ce-skilling-ai-copilot"
906+
"docs/ai/**/**.{md,yml}": "ce-skilling-ai-copilot"
912907
},
913908
"ms.update-cycle": {
914909
"docs/ai/**/**.{md,yml}": "180-days",
915-
"docs/csharp/whats-new/**/*.md": "1825-days",
916-
"docs/framework/**/*.md": "1825-days",
917-
"docs/visual-basic/**/*.md": "1825-days",
918-
"docs/framework/additional-apis/pos-for-net/**/**.md": "1825-days"
910+
"docs/csharp/whats-new/**/**.{md,yml}": "1095-days",
911+
"docs/csharp/advanced-topics/interop/**/**.{md,yml}": "1825-days",
912+
"docs/csharp/advanced-topics/reflection-and-attributes/**/**.{md,yml}": "1825-days",
913+
"docs/csharp/fundamentals/exceptions/**/**.{md,yml}": "1825-days",
914+
"docs/csharp/language-reference/**/**.{md,yml}": "1095-days",
915+
"docs/csharp/language-reference/compiler-messages/**/**.{md,yml}": "3650-days",
916+
"docs/csharp/language-reference/xmldoc/**/**.{md,yml}": "3650-days",
917+
"docs/csharp/linq/**/**.{md,yml}": "1825-days",
918+
"docs/csharp/misc/**/**.{md,yml}": "3650-days",
919+
"docs/csharp/roslyn-sdk/**/**.{md,yml}": "1825-days",
920+
"docs/csharp/specification/**/**.{md,yml}": "1825-days",
921+
"docs/framework/**/*.md": "3650-days",
922+
"docs/iot/**/**.{md,yml}": "1825-days",
923+
"docs/visual-basic/**/**.{md,yml}": "3650-days"
919924
},
920925
"no-loc": {
921926
"docs/orleans/**/**.md": [

docs/ai/conceptual/how-genai-and-llms-work.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ For example, given the user input *Give me three ideas for a healthy breakfast i
4646

4747
Some generative AI applications produce image outputs from natural language inputs. Depending on the application and its models, users might be able to specify:
4848

49-
- The people or things to appear the image
49+
- The people or things to appear in the image
5050
- The artistic style to create the image in
5151
- References for generating similar images
5252

docs/ai/conceptual/understanding-openai-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The Kernel builds the `tools` parameter of a request based on your decorators, o
5151

5252
## Token counts
5353

54-
Function descriptions are include in the system message of your request to a model. These function descriptions count against your model's [token limit](/azure/ai-services/openai/quotas-limits) and are [included in the cost of the request](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/).
54+
Function descriptions are included in the system message of your request to a model. These function descriptions count against your model's [token limit](/azure/ai-services/openai/quotas-limits) and are [included in the cost of the request](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/).
5555

5656
If your request exceeds the model's token limit, try the following modifications:
5757

docs/ai/conceptual/vector-databases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Vector databases and their search features are especially useful in [RAG pattern
3434
1. Store and index the embeddings in a vector database or search service.
3535
1. Convert user prompts from your application to embeddings.
3636
1. Run a vector search across your data, comparing the user prompt embedding to the embeddings your database.
37-
1. Use a language model such as GPT-35 or GPT-4 to assembly a user friendly completion from the vector search results.
37+
1. Use a language model such as GPT-35 or GPT-4 to assemble a user friendly completion from the vector search results.
3838

3939
Visit the [Implement Azure OpenAI with RAG using vector search in a .NET app](../tutorials/tutorial-ai-vector-search.md) tutorial for a hands-on example of this flow.
4040

docs/ai/conceptual/zero-shot-learning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Intent:
3232

3333
There are two primary use cases for zero-shot learning:
3434

35-
- **Work with fined-tuned LLMs** - Because it relies on the model's existing knowledge, zero-shot learning is not as resource-intensive as few-shot learning, and it works well with LLMs that have already been fined-tuned on instruction datasets. You might be able to rely solely on zero-shot learning and keep costs relatively low.
35+
- **Work with fined-tuned LLMs** - Because it relies on the model's existing knowledge, zero-shot learning is not as resource-intensive as few-shot learning, and it works well with LLMs that have already been fine-tuned on instruction datasets. You might be able to rely solely on zero-shot learning and keep costs relatively low.
3636
- **Establish performance baselines** - Zero-shot learning can help you simulate how your app would perform for actual users. This lets you evaluate various aspects of your model's current performance, such as accuracy or precision. In this case, you typically use zero-shot learning to establish a performance baseline and then experiment with few-shot learning to improve performance.
3737

3838
## Few-shot learning

docs/ai/get-started-mcp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ dotnet add package ModelContextProtocol --prerelease
6868

6969
Instead of building unique connectors for each integration point, you can often leverage or reference prebuilt integrations from various providers such as GitHub and Docker:
7070

71-
- [Available MPC clients](https://modelcontextprotocol.io/clients)
71+
- [Available MCP clients](https://modelcontextprotocol.io/clients)
7272
- [Available MCP servers](https://modelcontextprotocol.io/examples)
7373

7474
### Integration with Microsoft.Extensions.AI

docs/ai/microsoft-extensions-ai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ As with other `IChatClient` implementations, the `RateLimitingChatClient` can be
146146

147147
:::code language="csharp" source="snippets/microsoft-extensions-ai/ConsoleAI.CustomClientMiddle/Program.cs":::
148148

149-
To simplify the composition of such components with others, component authors should create a `Use*` extension method for registering the component into a pipeline. For example, consider the following `UseRatingLimiting` extension method:
149+
To simplify the composition of such components with others, component authors should create a `Use*` extension method for registering the component into a pipeline. For example, consider the following `UseRateLimiting` extension method:
150150

151151
:::code language="csharp" source="snippets/microsoft-extensions-ai/AI.Shared/RateLimitingChatClientExtensions.cs" id="one":::
152152

docs/ai/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Millions of developers use .NET to create applications that run on the web, on m
2525
The opportunities with AI are near endless. Here are a few examples of solutions you can build using AI in your .NET applications:
2626

2727
* Language processing: Create virtual agents or chatbots to talk with your data and generate content and images.
28-
* Computer vision: Identify objects in an object or video.
28+
* Computer vision: Identify objects in an image or video.
2929
* Audio generation: Use synthesized voices to interact with customers.
3030
* Classification: Label the severity of a customer-reported issue.
3131
* Task automation: Automatically perform the next step in a workflow as tasks are completed.

docs/azure/includes/dotnet-all.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,7 @@
414414
| Speech Extension Telemetry | NuGet [1.45.0](https://www.nuget.org/packages/Microsoft.CognitiveServices.Speech.Extension.Telemetry/1.45.0) | | |
415415
| System Net Client Model | NuGet [1.0.0-beta.1](https://www.nuget.org/packages/System.Net.ClientModel/1.0.0-beta.1) | | |
416416
| Unknown Display Name | NuGet [0.12.0](https://www.nuget.org/packages/Azure.Iot.Operations.Connector/0.12.0) | | |
417+
| Unknown Display Name | NuGet [0.1.0-preview.1](https://www.nuget.org/packages/Microsoft.Azure.Cosmos.Aot/0.1.0-preview.1) | | |
417418
| Unknown Display Name | NuGet [1.1.2-preview](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.AzureCosmosDb.Mongo/1.1.2-preview) | | |
418419
| Unknown Display Name | NuGet [1.45.0](https://www.nuget.org/packages/Microsoft.CognitiveServices.Speech.Extension.MAS/1.45.0) | | |
419420
| Unknown Display Name | NuGet [1.0.0](https://www.nuget.org/packages/Microsoft.Extensions.Caching.Postgres/1.0.0) | | |

0 commit comments

Comments
 (0)