dotnet / dotnet/EntityFramework.Docs

Find a way to make our API docs cover user-facing APIs only

Open
#4,227 0 comments 0 reactions 0 assignees View on GitHub
area-global
Dominant language
Mermaid
Stars
1.7k
Forks
2k
Avg merge
7d 23h
Merged PRs (30d)
16

Description

The EF API docs contain our entire public surface, mixing together the (considerable) provider-facing APIs with user-facing ones. This makes it difficult for regular users to find their way (e.g. #4226).

I'm not sure what filtering the doc system provides, but we know it's possible to at least filter out the Internal namespaces. We could start by specifically excluding certain namespaces which are known to be provider-only... At some point we may be able to also use attributes to indicate that something is provider-facing (or user-facing) and filter based on that...

* #4293

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.