docs: improve local setup guide #293
Merged
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
Shreyas-Microsoft
requested review from
Avijit-Microsoft,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft,
dgp10801,
marktayl1,
nchandhi and
toherman-msft
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the local development setup guide by completely rewriting and expanding the LocalDevelopmentSetup.md documentation. The update follows a comprehensive structure similar to a reference document and significantly enhances the developer experience.
Key Changes:
- Added detailed multi-service architecture explanation with terminal organization guidance
- Included platform-specific installation instructions (Windows native, WSL2, and Linux distributions)
- Expanded Azure infrastructure deployment steps with RBAC permission requirements
- Added comprehensive troubleshooting section with common issues and solutions
- Included new frontend_env_variables.png image to help users configure environment variables
Reviewed changes
Copilot reviewed 1 out of 3 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| docs/LocalDevelopmentSetup.md | New comprehensive local development setup guide with step-by-step instructions for prerequisites, development tools, Azure infrastructure, backend/frontend setup, debugging, Docker, and troubleshooting |
| docs/images/frontend_env_variables.png | New screenshot image showing frontend environment variable configuration reference |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 3 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Prajwal-Microsoft
approved these changes
Jan 1, 2026
Prajwal-Microsoft
approved these changes
Jan 1, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Successfully updated the LocalSetupGuide.md to follow the comprehensive structure and format of the reference document.
Summary of Changes
The updated guide now includes:
✅ Improved Introduction - Clear overview with multi-service architecture explanation
✅ Important Setup Notes - Terminal organization, path conventions, and configuration file details
✅ Step 1: Prerequisites - Platform-specific installation instructions for Windows (native & WSL2) and Linux
✅ Step 2: Development Tools - VS Code extensions, settings, and development container setup
✅ Step 3: Azure Infrastructure - Authentication, resource group creation, infrastructure deployment, and RBAC permissions
✅ Step 4: Backend Setup - Complete backend API configuration, dependencies, and startup instructions
✅ Step 5: Frontend Setup - Frontend installation, Azure AD configuration, and development server startup
✅ Step 6: Verification - Service status checklist and quick verification steps
✅ Step 7: Debugging - VS Code debugging configuration and logging setup
✅ Step 8: Docker - Optional containerized development instructions
✅ Comprehensive Troubleshooting - Expanded common issues with solutions and debug mode checklist
✅ Step 9: Next Steps - Clear guidance on what to do after setup
✅ Related Documentation - Updated links to other guides
The document now provides a professional, step-by-step guide with clear terminal organization, detailed explanations, and improved user experience following the reference format.
Does this introduce a breaking change?
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information