Skip to content

docs: Refactored Deployment guide to simplify and reorder the steps#52

Merged
Prajwal-Microsoft merged 7 commits intomainfrom
readme-updates
Nov 20, 2025
Merged

docs: Refactored Deployment guide to simplify and reorder the steps#52
Prajwal-Microsoft merged 7 commits intomainfrom
readme-updates

Conversation

@Prajwal-Microsoft
Copy link
Copy Markdown
Contributor

@Prajwal-Microsoft Prajwal-Microsoft commented Nov 18, 2025

Purpose

This pull request updates the documentation to improve guidance for Azure deployment and troubleshooting. The main focus is on making deployment resources more visible and providing quick access to recovery steps for failed deployments.

Documentation improvements:

  • Moved the Azure deployment guide link to the top of the deployment section in the README.md for better visibility and easier access.
  • Added a highlighted tip in docs/TroubleShootingSteps.md with a direct link to the "Recover from Failed Deployment" section in the deployment guide, helping users quickly find recovery instructions.

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • ...

Other Information

Updated the Deployment Guide to enhance clarity and structure, including an overview, prerequisites, and detailed setup instructions.
Added a note about deployment recovery help for failed deployments.
@Prajwal-Microsoft Prajwal-Microsoft merged commit 5dbd9b2 into main Nov 20, 2025
5 checks passed
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants