Skip to content

docs: Documentation updates - #75

Open
Yamini Dhiman (Yamini1-Microsoft) wants to merge 6 commits into
mainfrom
psl-doc-updates
Open

docs: Documentation updates #75
Yamini Dhiman (Yamini1-Microsoft) wants to merge 6 commits into
mainfrom
psl-doc-updates

Conversation

@Yamini1-Microsoft

@Yamini1-Microsoft Yamini Dhiman (Yamini1-Microsoft) commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

This pull request updates documentation and scripts to improve clarity and align with recent solution changes. The main updates include a major rewrite and expansion of the technical architecture documentation, quick access deployment badges in the README.md, and updates to default model versions and script usage examples.

Documentation improvements:

  • docs/TechnicalArchitecture.md: Completely rewritten and expanded to provide a clear, component-based technical overview, request flow diagram, and direct links to component-specific documentation. The new structure clarifies the roles of Work IQ, Fabric IQ, and Foundry IQ, and explains how they interact within the solution.
  • README.md: Added "Open in GitHub Codespaces" and "Open in Dev Containers" badges for quick deployment, making it easier for users to get started with the solution.

Script and configuration updates:

  • ...

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

@Yamini1-Microsoft
docs: comprehensive deployment guide and architecture updates
2174b61 
- README.md: Add quick deploy badges (GitHub Codespaces, Dev Containers)
- DeploymentGuide.md & DeploymentGuide-new.md:
  * Generalize model parameters to placeholders
  * Add 6 actual azd up interactive prompts (Section 4.4)
  * Add workspace ID requirement to Copilot Studio steps
  * Update flow name to 'When a New Email Arrives (V3)'
  * Remove Graph setup from tenant configuration
  * Add 3 troubleshooting sections: Foundry protocol error, Graph loading delay, Teams agent response
- TechnicalArchitecture.md: Complete rewrite with professional formatting
  * 3-layer architecture (Work IQ/Fabric IQ/Foundry IQ)
  * Component references and request flow diagram
- New: refresh_sample_data.ipynb in src/fabric/datagen/
  * Automate static data regeneration with validation
  * 5 sections: imports, config, generation, validation, file copying
- New: infra/scripts/README.md with script usage documentation
- Minor fixes to quota_check_params.sh and Run-PythonScript.ps1
@Yamini1-Microsoft
docs: improve Azure Foundry Agent Protocol Error troubleshooting section
0da7bf8 
- Reformatted error message into code block for clarity
- Fixed typos: 'Symptoms:**v**' and 'puplish'
- Reorganized into 6 sequential, actionable steps
- Made Activity Protocol mode fix more prominent
- Added helpful details like wait times and verification steps
- Improved overall flow and readability for users troubleshooting protocol errors
Copilot AI review requested due to automatic review settings July 23, 2026 12:09
Copilot AI reviewed Jul 23, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates documentation and helper scripts to reflect the current Microsoft IQ Solution Accelerator architecture, deployment entry points, and default model selection.

Changes:

  • Added quick-launch badges in the README for Codespaces and Dev Containers.
  • Rewrote/expanded the technical architecture documentation and significantly restructured the deployment guide.
  • Updated default quota-check model to gpt-5-mini and adjusted PowerShell script parameter examples to reference the unified install/remove scripts.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
README.md Adds Codespaces and Dev Containers badges to speed up onboarding/deployment.
infra/scripts/utils/Run-PythonScript.ps1 Updates ScriptPath parameter examples to point at unified install/remove scripts.
infra/scripts/quota_check_params.sh Updates the default quota-check chat model to gpt-5-mini.
docs/TechnicalArchitecture.md Replaces the prior short description with a component-based architecture overview and request flow.
docs/DeploymentGuide.md Large rewrite/restructure of the end-to-end deployment guide content and layout, plus new troubleshooting/cleanup guidance.

Comment thread docs/DeploymentGuide.md Outdated
Comment thread docs/DeploymentGuide.md
Comment thread docs/DeploymentGuide.md Outdated
Comment thread infra/scripts/utils/Run-PythonScript.ps1
@Yamini1-Microsoft
fix: address Copilot PR review comments (comments 3 and 4)
bce8a6d 
- Comment 3: Change azd down cleanup command from 'azd down --force --purge' to 'azd down'
  * Make --purge optional with comment to preserve local env config by default
  * More conservative approach allows users to keep local configuration for recovery

- Comment 4: Update Run-PythonScript.ps1 documentation
  * Update .EXAMPLE blocks to reference new unified scripts (install/remove_microsoft_iq_solution.py)
  * Update HelpMessage parameter to match current script paths
  * Maintain consistency with updated parameter documentation
@Yamini1-Microsoft

Yamini Dhiman (Yamini1-Microsoft) commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

Yamini Dhiman (@Yamini1-Microsoft) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree company="Microsoft"

@Yamini1-Microsoft Yamini Dhiman (Yamini1-Microsoft) changed the title docs: Documenattion updates docs: Documentation updates Jul 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@Avijit-Microsoft Avijit-Microsoft Awaiting requested review from Avijit-Microsoft Avijit-Microsoft is a code owner
@Roopan-Microsoft Roopan-Microsoft Awaiting requested review from Roopan-Microsoft Roopan-Microsoft is a code owner
@Prajwal-Microsoft Prajwal-Microsoft Awaiting requested review from Prajwal-Microsoft Prajwal-Microsoft is a code owner
@aniaroramsft Anish Arora (aniaroramsft) Awaiting requested review from aniaroramsft aniaroramsft is a code owner
@Vinay-Microsoft Vinay Sharma (Vinay-Microsoft) Awaiting requested review from Vinay-Microsoft Vinay-Microsoft is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Yamini1-Microsoft