AzureAD / microsoft-identity-web

Helps creating protected web apps and web APIs with Microsoft identity platform and Azure AD B2C
MIT License
678 stars 209 forks source link

[Documentation] Documentation confusing #2634

Open RihanArfan opened 9 months ago

RihanArfan commented 9 months ago

Please check all that apply

Description of the issue

I've implemented Microsoft Identity Web (v2) into a .NET 6 MVC app that calls a Web API and I remember struggling and large fustration due documentation being conflicting, spread out, lacking and/or outdated. Once again, I've had to experience this while trying to find clear and straight forward documentation for using Microsoft Graph with Microsoft.Identity.Web for a colleague.

It seems like the main documentation for Microsoft.Identity.Web is spread between GitHub Wiki and Microsoft Learn, and the majority of it being outdated and for v1, when v2 has been out for a while. Guides for doing certain things are also unclear. I'm not sure what a fitting title for this issue is. First example is Microsoft.Identity.Web v2 introduced IDownstreamApi, but is only mentioned on the "news" page for v2, but not on Microsoft Learn or elsewhere on the wiki.

Another example, if I want to find documentation for how to call Microsoft Graph from a .NET MVC app. There are over 6 different guides/areas to look, none of which consistent. I understand this specific example might be more specific to Graph than Microsoft.Identity.Web, although I am trying to call it from an app that uses Microsoft.Identity.Web which involves Graph related things in the SDK.

Finally, parts of the wiki also seems to be unmaintained or outdated, with a lot of pages not touched for over 2-3 years. I do understand some things haven't changed, but I'm focusing on pages like Why use Microsoft Identity Web? which still have mentions to .NET Core 3.1 (EOL) despite .NET 8 being the current latest LTS.

I hope my tone doesn't come across as hateful and I mean no hate to anyone involved. Documentation is a big issue I've seen in the .NET ecosystem especially with this package and I hope that bringing attention to the problems I've faced can help improve the docs for others. 😃

jennyf19 commented 9 months ago

Thanks @RihanArfan for the feedback. We are aware of the documentation gaps with Id Web and are working on addressing them.

jmprieur commented 9 months ago

Thanks for the feedback, @RihanArfan. I totally agree.