dotnet / aspnetcore

ASP.NET Core is a cross-platform .NET framework for building modern cloud-based web applications on Windows, Mac, or Linux.
https://asp.net
MIT License
35.18k stars 9.93k forks source link

Your documentation is horrible and needs a complete restructuring and rewrite #33398

Closed v8ify closed 3 years ago

v8ify commented 3 years ago

I know this isn't the Docs repository but you need to be aware of the issue.

There are lots of issues with ASP.NET Core documentation so I will highlight few.

1. The structure:

_Why do we need two tutorials for every project type?!!_

Here's one at Tutorials > Razor Pages

razor1

Here's one at Web Apps > Razor Pages > Tutorial

razor2

My problem is it forces us to follow the sample app they are building and not give us the quick docs and info we want.



You guys seriously need to learn from Django how to build a well structured documentation. Amazing that a non-profit builds a better documentation than a billion dollar company. Is it because you are too focused on adding new features that you forgot how important docs are? Or is it because you don't have enough (and competent) people who can design and write clear documentation?



2. Search Engine Optimization

The docs site sucks at SEO. Even when I type right keywords it never shows me the correct page in the docs. Never. This might be the direct consequence of horrible structure and relying on tutorial style docs. Every time I have to read through pages and pages to get to the real thing. Ditch the tutorial style docs and this will be a lot better.


Please take a look at Django docs and learn how to structure documentations. Your current docs may be good enough for people with experience in ASP.NET who work in a enterprise environment where they have seniors advising them, but it is absolutely unacceptable (not to mention, frustrating) for people new to the ASP.NET Core.


Seriously, learn from Django docs

blowdart commented 3 years ago

Did you file an issue in the docs repo at all?

v8ify commented 3 years ago

@blowdart yes i did.

blowdart commented 3 years ago

Then this is a dupe of https://github.com/dotnet/AspNetCore.Docs/issues/22521 so closing