dotnet / dotnet/winforms

Make Triple Slash Comments Source of Truth

Open
#12,262 3 comments 2 reactions 0 assignees View on GitHub
area-Infrastructure
Dominant language
C#
Stars
4.9k
Forks
1.1k
Avg merge
1d 13m
Merged PRs (30d)
85

Description

Currently we need to manually port any new documentation to the dotnet-api-docs repo when it comes time to documenting new APIs that have been added in the release cycle. We should investigate making our source code documentation the source of truth so that we reduce the manual effort that occurs when it comes time to documenting new APIs for the release cycle.

In runtime repo, this has already been achieved for some projects by creating a [transport package](https://github.com/dotnet/runtime/blob/eb14da93fe4fd29cc80eba6b12c6452ea10d166e/src/libraries/Microsoft.Internal.Runtime.DotNetApiDocs.Transport/src/Microsoft.Internal.Runtime.DotNetApiDocs.Transport.proj) that automatically pushes the ref assemblies and the intellisense files to a feed where the dotnet-api-docs repo consumes that package to update the Microsoft Learn website.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.