Skip to content

Conversation

@VishalS-Microsoft
Copy link
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants