API docs parity: .NET

Open
#1,657 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Quiet
Tech stack
csharp
Domain
documentation

Research direction

Start by reviewing the .NET API surface covered by this parity issue and the repository's existing documentation approach. The issue specifies XML documentation comments and discusses NuGet packaging and DocFX, but names no files, tests, or exact API scope. Done would require an agreed .NET documentation scope and a documented way to produce or publish the API reference.

Written by the indexing model from the issue text.

Description

enhancement sdk/dotnet

.NET API Docs

Parent epic: #1653

Doc format: XML documentation comments (/// <summary>, <param>, <returns>, etc.). The compiler emits a .xml file alongside the assembly.

Culture: Strong and enforced. NuGet packages conventionally include the XML doc file in the package (IDE IntelliSense reads it). Microsoft's own libraries always ship it. Roslyn analyzers can warn on missing docs.

Hosting analogues:

Service How it works
fuget.org ⚠️ Defunct — DNS no longer resolves as of 2026-06-13. Was the closest analogue to javadoc.io for NuGet packages
NuGet package page Shows README, not full API surface
DocFX Microsoft's Sphinx-equivalent generator; many projects self-host output on GitHub Pages

Note on fuget.org: fuget.org was the only third-party service that automatically rendered API docs from NuGet packages (analogous to javadoc.io). As of 2026-06-13 it is completely offline — DNS does not resolve. This means there is no automatic, zero-config API docs host for .NET packages. Self-hosted DocFX output (e.g. GitHub Pages from CI) is the only viable option.

Key difference from Java: The XML doc file ships inside the .nupkg (analogous to javadoc jar living in Maven Central), so IDEs can consume it without separate publication. But NuGet doesn't mandate it the way Maven Central does, and with fuget.org gone, there is no hosted equivalent to javadoc.io for .NET.

Dominant language
Java
Stars
10.5k
Forks
1.5k
Avg merge
1d 12h
Merged PRs (30d)
133

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/copilot-sdk

All issues in github/copilot-sdk

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.