search

OData / AspNetCoreOData

ASP.NET Core OData: A server library built upon ODataLib and ASP.NET Core
Other
455 stars 156 forks source link

Documentation on MS Docs needs updating (v8) #260

Open tyh77 opened 3 years ago

tyh77 commented 3 years ago

Most of the documentation here: https://docs.microsoft.com/en-us/odata/webapi/getting-started

Target the OData ASP.NET, ASP.NET Core library v6 or v7. There is no documentation on v8 other than a few blogs outlining changes with respect to Endpoint Routing.

As a user who is looking to adopt OData for our ASP.NET Core Web APIs for the first time, it's rather confusing to see information scattered across blog posts and none of them fully documented on MS Docs. First I had to read the v6/v7 docs to understand fundamentals then read the v7->v8 changes to understand the incremental changes.

(If I'm a new user coming to OData for the first time, I really don't need to see v6/v7. It should be a 1-step onboard to v8)

In fact, the MS Docs documentation makes zero references to ASP.NET Core 3.1 even (still referencing v2), when 3.1 has already become LTS with .NET 5 being pushed officially, and .NET 6 just around the corner.

xuzhg commented 3 years ago

@tyh77 Yes. Totally agree with you.

ekomut commented 3 years ago

This is very important!