From aa08ab7aa83e3c69c3e296c1bbb31ee5c1f30a58 Mon Sep 17 00:00:00 2001 From: Noah Falk Date: Sat, 1 Nov 2025 14:00:35 -0700 Subject: [PATCH 1/3] Update README with API reference documentation details The links from the api-docs repo has a bunch of general info about the doc updates and desired content style, but I didn't see anything that tells contibutors if their edit should be made in this repo or elsewhere. The runtime docs do talk about that, but those docs weren't easily discoverable from here. I'm not sure if the front README is the right place for this, but I didn't see a better place. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 845641c5e70..f3a4bfa4be0 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ To contribute, see: - The [.NET Contributor Guide :ledger:](https://learn.microsoft.com/contribute/dotnet/dotnet-contribute) for instructions on procedures we use. - Issues labeled [`help wanted` :label:](https://github.com/dotnet/dotnet-api-docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+) for ideas. +- The API reference docs for some assemblies are maintained in the assembly's source code outside this repo, then edits to the XML here are auto-generated and ported. Docs for APIs in those assemblies should be updated by editing the source code comments. See [here](https://github.com/dotnet/runtime/docs/adding-api-guidelines.md#documentation) for details. ## :bookmark_tabs: Code of conduct From e0b80d853648e2a94598be695f7a04ceb954a0f9 Mon Sep 17 00:00:00 2001 From: Noah Falk Date: Sat, 1 Nov 2025 14:05:59 -0700 Subject: [PATCH 2/3] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f3a4bfa4be0..eb06c7b5113 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ To contribute, see: - The [.NET Contributor Guide :ledger:](https://learn.microsoft.com/contribute/dotnet/dotnet-contribute) for instructions on procedures we use. - Issues labeled [`help wanted` :label:](https://github.com/dotnet/dotnet-api-docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+) for ideas. -- The API reference docs for some assemblies are maintained in the assembly's source code outside this repo, then edits to the XML here are auto-generated and ported. Docs for APIs in those assemblies should be updated by editing the source code comments. See [here](https://github.com/dotnet/runtime/docs/adding-api-guidelines.md#documentation) for details. +- The API reference docs for some assemblies are maintained in the assembly's source code outside this repo. Edits to the XML here are auto-generated and ported, so docs for APIs in those assemblies should be updated by editing the source code comments. See [here](https://github.com/dotnet/runtime/docs/adding-api-guidelines.md#documentation) for details. ## :bookmark_tabs: Code of conduct From 3fca49cd08c7c8028e9ebaa25e9d110745e81e63 Mon Sep 17 00:00:00 2001 From: Noah Falk Date: Mon, 3 Nov 2025 15:31:05 -0800 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eb06c7b5113..b9400709646 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,9 @@ To contribute, see: - The [.NET Contributor Guide :ledger:](https://learn.microsoft.com/contribute/dotnet/dotnet-contribute) for instructions on procedures we use. - Issues labeled [`help wanted` :label:](https://github.com/dotnet/dotnet-api-docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+) for ideas. -- The API reference docs for some assemblies are maintained in the assembly's source code outside this repo. Edits to the XML here are auto-generated and ported, so docs for APIs in those assemblies should be updated by editing the source code comments. See [here](https://github.com/dotnet/runtime/docs/adding-api-guidelines.md#documentation) for details. +- The API reference docs for some assemblies are maintained in the assembly's source code outside this repo. For those assemblies, edits to the XML here are auto-generated and ported, so docs for APIs in those assemblies should be updated by editing the source code comments. For more information, see [here](https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/adding-api-guidelines.md#documentation). + + Namespaces and types whose docs are maintained in the assembly's source code repo set the [`open_to_public_contributors`](https://github.com/dotnet/dotnet-api-docs/blob/0ddbf94c587e7bdbbadc813a8b58fc4160a47b1f/docfx.json#L164) metadata to `false`. (That metadata disables the Edit button on the published docs.) ## :bookmark_tabs: Code of conduct