Update README with API reference documentation details#12004
Merged
gewarren merged 3 commits intodotnet:mainfrom Nov 4, 2025
Merged
Update README with API reference documentation details#12004gewarren merged 3 commits intodotnet:mainfrom
gewarren merged 3 commits intodotnet:mainfrom
Conversation
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.
github-actions
bot
added
the
needs-area-label
dotnet-policy-service
bot
added
the
community-contribution
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds guidance to the README about assemblies whose API documentation is maintained in source code outside the repository. The new contribution guideline informs contributors that some assemblies have their documentation auto-generated from source code comments elsewhere, and provides a link to detailed instructions.
- Adds a new bullet point in the "Contribute" section explaining the documentation workflow for certain assemblies
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Member
Author
|
fyi @jkotas - This edit would help people looking at this repo to find the edits you are making in the runtime repo. |
gewarren
approved these changes
Nov 3, 2025
Contributor
gewarren
left a comment
gewarren
left a comment
There was a problem hiding this comment.
I added some additional info that might be helpful.
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
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.