Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #549

Merged
merged 1 commit into from
Nov 1, 2024
Merged

Update README.md #549

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down
Loading