docs: added local setup readme #105
Open
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 enhances the documentation to better support both Azure deployment and local development workflows. The most significant updates are the addition of a dedicated local development setup guide and improved navigation for installation instructions. There is also a minor formatting change in a sample configuration file.
Documentation improvements:
README.mdto clearly separate Azure deployment instructions from local development, and added links to a new comprehensive local development setup guide covering Windows, WSL2, and cross-platform tools.documents/DeploymentGuide.mddirecting users to the local development setup guide for running the application locally.Configuration file formatting:
src/api/dotnet/appsettings.json.sampleby adding a trailing comma for consistency.Does this introduce a breaking change?
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information