Skip to content

Update README with API reference documentation details #12004

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.

Sign up for GitHub

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 3 commits into from
Nov 4, 2025
Merged

Update README with API reference documentation details #12004

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa08ab7
Update README with API reference documentation details
noahfalk Nov 1, 2025
e0b80d8
Update README.md
noahfalk Nov 1, 2025
3fca49c
Apply suggestions from code review
noahfalk Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +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. 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

Expand Down