Skip to content

docs: Updated README file for MACAE#652

Merged
Roopan-Microsoft merged 2 commits into
mainfrom
psl-README-change
Nov 20, 2025
Merged

docs: Updated README file for MACAE#652
Roopan-Microsoft merged 2 commits into
mainfrom
psl-README-change

Conversation

@Prekshith-Microsoft

Copy link
Copy Markdown
Contributor

This pull request significantly reorganizes and enhances the DeploymentGuide.md documentation to improve clarity, usability, and guidance for deploying the solution. Key improvements include restructuring deployment options, clarifying environment setup steps, adding critical warnings, and streamlining post-deployment instructions.

Major documentation improvements:

Deployment options and configuration:

  • Reorganized and clarified deployment options, moving sandbox and WAF-aligned (production) deployment instructions into a dedicated "Deployment Options" section, with clear guidance on choosing and configuring each option. [1] [2]
  • Added explicit steps and warnings for VM credentials configuration and emphasized the need to review parameter values for production deployments.

Environment management and redeployment:

  • Introduced a critical warning and detailed instructions for creating a fresh environment when redeploying to avoid conflicts, including reasons for this requirement.

Deployment step updates and post-deployment guidance:

  • Updated deployment step references and instructions for Codespaces, VS Code Dev Containers, and local environments to point to the new deployment options section. [1] [2] [3]
  • Improved clarity and order of post-deployment steps, including uploading team configurations, indexing sample data, setting up authentication, accessing the application, and cleaning up resources. Added a "Next Steps" section for trying out the solution and moved clean-up instructions for resource deletion. [1] [2] [3] [4] [5]

Additional clarifications:

  • Added a note explaining automatic Cosmos DB access permissions granted upon deployment.
  • Included a warning about the behavior of azd init to prevent accidental overwriting of existing project files.

These changes collectively make the deployment process clearer, safer, and more accessible for users at all experience levels.## Purpose

  • ...

Does this introduce a breaking change?

  • Yes
  • No

How to Test

  • Get the code
git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install
  • Test the code

What to Check

Verify that the following are valid

  • ...

Other Information

@Roopan-Microsoft Roopan-Microsoft merged commit 420718b into main Nov 20, 2025
8 checks passed
@github-actions

github-actions Bot commented Dec 5, 2025

Copy link
Copy Markdown

🎉 This PR is included in version 3.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

deepammi pushed a commit to deepammi/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator that referenced this pull request Dec 7, 2025
@Harmanpreet-Microsoft Harmanpreet-Microsoft deleted the psl-README-change branch January 2, 2026 07:54
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