From f4ac4e67a067c6a73cb74c330bd4d77613477e3d Mon Sep 17 00:00:00 2001 From: Den <53200638+localden@users.noreply.github.com> Date: Fri, 1 Nov 2024 13:48:58 -0700 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bc472fcc1..d64007379 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,26 @@ # Microsoft Authentication Library for .NET -This is the documentation repository for Microsoft Authentication Library (MSAL) for .NET. If you are looking for the library, refer to [AzureAD/microsoft-authentication-library-for-dotnet](https://github.com/AzureAD/microsoft-authentication-library-for-dotnet). +This is the **documentation repository** for Microsoft Authentication Library (MSAL) for .NET. + +| Resource | Location | +|:-----------------------------|:-----------| +| 👋 **SDK Repository** | [`AzureAD/microsoft-authentication-library-for-dotnet`](https://github.com/AzureAD/microsoft-authentication-library-for-dotnet) | +| 👋 **SDK Package** | [`Microsoft.Identity.Client`](https://www.nuget.org/packages/Microsoft.Identity.Client/) | +| 👋 **SDK Documentation** | [MSAL.NET on Microsoft Learn](https://learn.microsoft.com/entra/msal/dotnet/) | +| 🔒 **SDK Documentation CI Job** | [Azure Pipelines](https://apidrop.visualstudio.com/Content%20CI/_build?definitionId=5311) | ## Contributions Contributions to our documentation are welcome. Make sure to familiarize yourself with the [Microsoft Writing Style Guide](https://learn.microsoft.com/style-guide/welcome/) and the [Contributor Guide](https://learn.microsoft.com/contribute/) before making any changes. -> **Warning** -> **Do not** modify any XML files in the `dotnet/xml` folder - those are generated automatically from the library source code and any changes will be automatically overwritten the next time the documentation [Continuous Integration (CI) job](https://apidrop.visualstudio.com/Content%20CI/_build?definitionId=5311) runs. To make changes to any API docs you will need to open a pull request in the [AzureAD/microsoft-authentication-library-for-dotnet](https://github.com/AzureAD/microsoft-authentication-library-for-dotnet) repository. - If you would like to author an entirely new document (e.g., for a new scenario), make sure to [open an issue](https://github.com/MicrosoftDocs/microsoft-authentication-library-dotnet/issues) first. This will allow the engineering team to discuss the proposed changes and ensure that it won't be overwritten by future changes. +## API Documentation + +**Do not** modify any XML files in the `dotnet/xml` folder - those are generated automatically from the library source code and any changes will be automatically overwritten the next time the documentation runs. + +To make changes to any API docs you will need to open a pull request in the [`AzureAD/microsoft-authentication-library-for-dotnet`](https://github.com/AzureAD/microsoft-authentication-library-for-dotnet) repository and amend code comments. + ## Microsoft Open Source Code of Conduct This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).