Skip to content

docs: Refactor deployment guide Readme #65

Merged
Prajwal-Microsoft merged 3 commits intomainfrom
readme-updates
Nov 28, 2025
Merged

docs: Refactor deployment guide Readme #65
Prajwal-Microsoft merged 3 commits intomainfrom
readme-updates

Conversation

@Prajwal-Microsoft
Copy link
Copy Markdown
Contributor

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

Purpose

This pull request updates the docs/DeploymentGuide.md to improve clarity, organization, and usability of the deployment documentation. The changes streamline configuration instructions, expand on testing procedures, and introduce a dedicated section for deploying local changes. The most important updates are grouped below:

Configuration and Setup Improvements:

  • Simplified the configuration copy instructions by removing detailed manual and command-line options, focusing on clear, step-by-step guidance for beginners.
  • Enhanced the configurable parameters section to provide a concise overview of what can be customized before deployment, with a clear reference to the full customization guide.
  • Clarified deployment prompts to distinguish between Azure AI Foundry deployment region and primary location, and added resource group selection steps for greater transparency.

Testing and Workflow Enhancements:

  • Expanded post-deployment testing instructions with a new subsection for application testing, including both quick test steps and a reference to a detailed workflow guide.

Advanced Usage and Local Development:

  • Added a comprehensive "Advanced: Deploy Local Changes" section detailing how to swap configuration and infrastructure files to deploy local modifications, replacing previously terse instructions and improving developer experience.

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

@Prajwal-Microsoft Prajwal-Microsoft merged commit deb0a2c into main Nov 28, 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.

2 participants