docs: readme and doc update #230
Merged
+23
−25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
judgement spelling was inconsistent in the file
Spelling Mistake "idenity" → should be "identity" and "sucessfully" → should be "successfully"
upload 2 missing files 1-resource-groups.png 2.resourcegroup.png
upload missing files 1.deleteservices.png 2.DeleteRG.png
make spelling correction: deployment plane -> deployment plan
Removed the section "Application interface" to maintain the consistency and also image was same in business scenario.
Table of Content section moved to top
In Point no 7, update the E.g. Link
update the URL
Atulku-Microsoft
requested review from
Avijit-Microsoft,
Fr4nc3,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft and
marktayl1
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR updates project documentation with corrections, new formatting, and content clarifications.
- Fixed typos and formatting in the Azure App Service Auth Setup guide.
- Updated deployment instructions and text formatting in the DeploymentGuide document.
- Added a new Table of Contents to the CustomizeSolution document and refined content in the README file.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| documentation/azure_app_service_auth_setup.md | Corrected typos and updated a URL example with unintended extra angle brackets. |
| documentation/DeploymentGuide.md | Adjusted the formatting of the Bicep deployment instructions. |
| documentation/CustomizeSolution.md | Added a detailed Table of Contents to improve navigation. |
| README.md | Removed the application interface screenshot and updated legal disclaimer formatting. |
Comments suppressed due to low confidence (1)
documentation/DeploymentGuide.md:260
- There is an extra space in 'Show deployment plan'. Removing the extra space will improve the formatting and clarity of the instructions.
- - You can use the Bicep extension for VSCode (Right-click the `.bicep` file, then select "Show deployment plan") or use the Azure CLI:
|
|
||
| 8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 1](#step-1-add-authentication-in-azure-app-service-configuration) and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name. | ||
| E.g. https://appservicename.azurewebsites.net/.auth/login/aad/callback | ||
| E.g. <<https://<< appservicename >>.azurewebsites.net/.auth/login/aad/callback |
There was a problem hiding this comment.
The URL example includes extra angle brackets which may confuse readers. Consider revising it to a standard URL format such as 'https://appservicename.azurewebsites.net/.auth/login/aad/callback'.
update the URL
update the URL
Roopan-Microsoft
approved these changes
May 23, 2025
Roopan-Microsoft
changed the title
|
🎉 This PR is included in version 1.5.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
blessing-msft
pushed a commit
that referenced
this pull request
Aug 1, 2025
docs: readme and doc update
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
*Updated the readme and docs files
Does this introduce a breaking change?
Other Information
Updated the below files
and upload some images