docs: Add local development setup guide and update deployment for DocGen#640
Merged
Prajwal-Microsoft merged 7 commits intodevfrom Jan 2, 2026
Merged
docs: Add local development setup guide and update deployment for DocGen#640Prajwal-Microsoft merged 7 commits intodevfrom
Prajwal-Microsoft merged 7 commits intodevfrom
Conversation
…s and prerequisites
Contributor
There was a problem hiding this comment.
Pull request overview
This PR renames and significantly expands the local development documentation for the Document Generation Solution Accelerator. The changes improve clarity, add platform-specific setup instructions, and enhance discoverability through navigation links in the main README and deployment guide.
Key Changes:
- Renamed
LocalDebuggingSetup.mdtoLocalDevelopmentSetup.mdwith expanded content including detailed architecture overview, multi-platform setup instructions (Windows, Linux, macOS), troubleshooting section, and Azure RBAC permissions guidance - Added prominent navigation links in README.md and DeploymentGuide.md pointing to the new local development guide
- Included comprehensive troubleshooting section covering Python versions, virtual environments, permissions, and Azure authentication
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| docs/LocalDevelopmentSetup.md | New comprehensive local development guide with platform-specific instructions, architecture overview, and troubleshooting section (replaces LocalDebuggingSetup.md) |
| docs/LocalDebuggingSetup.md | Removed (replaced by LocalDevelopmentSetup.md) |
| docs/DeploymentGuide.md | Added navigation link to the new local development setup guide |
| README.md | Added "For Local Development" section with link to the comprehensive setup guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… and formatting improvements
Added verification steps for backend and frontend services, including terminal status checklist and common issues.
Contributor
|
🎉 This PR is included in version 1.7.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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
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
This pull request updates documentation to make local development setup clearer and easier to follow. The main changes include renaming and expanding the local development guide, adding troubleshooting steps, and improving navigation to local setup instructions from the main README and deployment guide.
Local Development Documentation Improvements:
docs/LocalDebuggingSetup.mdtodocs/LocalDevelopmentSetup.mdand updated its title and section headings for clarity and consistency.Troubleshooting and Support:
Navigation and Accessibility:
README.mdanddocs/DeploymentGuide.mdto the new local development setup guide, making it easier for users to find local setup instructions. [1] [2]Reference Documentation:
Does this introduce a breaking change?
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information