Skip to content

docs: Add local development setup guide and update deployment for DocGen#640

Merged
Prajwal-Microsoft merged 7 commits intodevfrom
psl-localsetupdoc-docgen
Jan 2, 2026
Merged

docs: Add local development setup guide and update deployment for DocGen#640
Prajwal-Microsoft merged 7 commits intodevfrom
psl-localsetupdoc-docgen

Conversation

@VishalS-Microsoft
Copy link
Copy Markdown
Contributor

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:

  • Renamed docs/LocalDebuggingSetup.md to docs/LocalDevelopmentSetup.md and updated its title and section headings for clarity and consistency.
  • Expanded the local development guide with detailed setup instructions for Windows, Linux, and macOS, including step-by-step backend API startup commands for each platform, and guidance on environment variable configuration for development mode. [1] [2] [3]

Troubleshooting and Support:

  • Added a comprehensive troubleshooting section to the local development guide, covering Python version issues, virtual environment setup, permissions, Windows-specific problems, Azure authentication, and environment variable validation.

Navigation and Accessibility:

  • Added prominent links in the README.md and docs/DeploymentGuide.md to the new local development setup guide, making it easier for users to find local setup instructions. [1] [2]

Reference Documentation:

  • Included links to related documentation (deployment, resource group deletion, authentication, PowerShell setup, quota checks) in the local development guide for easier access to supporting materials.

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

  • I have built and tested the code locally and in a deployed app
  • For frontend changes, I have pulled the latest code from main, built the frontend, and committed all static files.
  • This is a change for all users of this app. No code or asset is specific to my use case or my organization.

Other Information

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 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.md to LocalDevelopmentSetup.md with 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.

Added verification steps for backend and frontend services, including terminal status checklist and common issues.
@Prajwal-Microsoft Prajwal-Microsoft merged commit 8d30685 into dev Jan 2, 2026
3 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 5, 2026

🎉 This PR is included in version 1.7.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@Priyanka-Microsoft Priyanka-Microsoft deleted the psl-localsetupdoc-docgen branch January 5, 2026 13:29
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