dotnet / dotnet/EntityFramework.Docs

Make getting started more obvious when reading docs

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

Description

We have had lots of great conversations over the last couple of years on improving doc layout. I don't want to forget all that, but this is something we could potentially do that is low cost and will help people getting started.

I have been reading [Cosmos docs](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/), and I noticed this structure:

image

That is, at the top level there are "Quickstarts" "Tutorials". These break out for the potential dimensions--in Cosmos case, the platforms/languages. The tutorials are then about building different kinds of applications.

image

For us, I think it would be:

- Quickstarts
- Use EF Core with Azure Cosmos DB
- Use EF Core with Azure SQL
- Use EF Core with SQL Server on-premise
- Use EF Core with PostgreSQL
- Use EF Core with SQLite
- Use EF Core with MongoDB
- Use EF Core with MySql
- Use EF Core with Oracle
- Tutorials
- Build a console application with EF Core
- Build an ASP.NET Core minimal API with EF Core
- Build an ASP.NET Core Blazor application with EF Core
- Build a Windows Forms application with EF Core
- Build a MAUI application for EF Core
- Build a WPF application with EF Core
- Use EF Core in Jupyter Notebooks

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.