API ref docs

[pranavkm]

This issue tracks filling in the blanks in our API ref docs. We'd like to make sure all public API surface in our types are documented and that we're able to enable the doc warning CS1591 in our projects.

Later this week, we'll follow up on doing a pass on APIs that are commonly used by project templates and user code to figure out if we need expand on the documentation coverage there or if the language can be simplified. We want to incorporate more of our concept docs too if it is helpful. Feel free to do an initial pass on areas that you're working on to also cover this.

• Hosting, Http Abstractions, Routing (@captainsafia)
• Servers
  • IIS (@jkotalik)
  • Kestrel (@javiercn)
  • HttpSys (@wtgodbe)
• Middleware
  • Static files, HttpsPolicy, Diagnostics, HostFiltering, ResponseCaching, HttpOverrides (@JunTaoLuo)
  • Localization, Localization.Routing, ResponseCompression (@SteveSandersonMS)
  • WebSockets (@BrennanConroy)
  • HealthChecks, CORS (@JamesNK)
  • Session, Diagnostics.EntityFrameworkCore, MiddlewareAnalysis, , HeaderPropagation, NodeServices (@halter73)
  • Rewrite (@jkotalik)
• Security - Authentication, CookiePolicy (@pranavkm)
• MVC
• Components (@HaoK)
• SignalR (@BrennanConroy)
• Identity, IdentityUI (@HaoK)

Once a project has 100% doc coverage, consider enabling warnings for missing docs by adding this to your project file:

<NoWarn>$(NoWarn.Replace('1591', ''))</NoWarn>