dotnet / dotnet/dotnet-api-docs

Add See Also links to API ref content

Open
#7,451 4 comments 6 reactions 1 assignee Claimed by @gewarren View on GitHub
area-Infrastructure Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

We've heard feedback that code examples for newer APIs exist mostly in conceptual docs. But web searches don't always produce those conceptual docs. In general, API ref is lacking code examples. This issue aims to address this problem with a first step of adding See Also links from high page view (but low CSAT) API ref articles to conceptual articles that have xref links to the API.

As a next step, we can look at expanding the See Also links to include links to:

- articles with code snippets that use the API
- code samples that use the API

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.