docs: Added changes in readme file related to SFI#186
Merged
Conversation
Atulku-Microsoft
requested review from
Avijit-Microsoft,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft and
marktayl1
as code owners
August 7, 2025 17:12
|
|
||
| ## For local Debugging | ||
|
|
||
| To configure your environment, navigate to the `src\backend` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**". |
There was a problem hiding this comment.
The documentation uses inconsistent path separators. Use forward slashes (src/backend) for cross-platform compatibility instead of backslashes (src\backend).
Suggested change
| To configure your environment, navigate to the `src\backend` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**". | |
| To configure your environment, navigate to the `src/backend` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**". |
|
|
||
| ## For local Debugging | ||
|
|
||
| To configure your environment, navigate to the `src\backend` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**". |
There was a problem hiding this comment.
[nitpick] The sentence is quite long and covers multiple steps. Consider breaking it into numbered steps or bullet points for better readability and clarity.
Suggested change
| To configure your environment, navigate to the `src\backend` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**". | |
| To configure your environment: | |
| 1. Navigate to the `src\backend` folder. | |
| 2. Create a `.env` file based on the `.env.sample` file. | |
| 3. Fill in the `.env` file using the deployment output or by checking the Azure Portal under "Deployments" in your resource group. | |
| 4. Ensure that `APP_ENV` is set to "**dev**" in your `.env` file. |
Prajwal-Microsoft
approved these changes
Aug 11, 2025
Ritesh-Microsoft
pushed a commit
that referenced
this pull request
Oct 10, 2025
docs: Added changes in readme file related to SFI
|
🎉 This PR is included in version 1.5.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
Add the content for env changes in DeploymentGuide.md
Does this introduce a breaking change?
Other Information
Added the new section (For local Debugging) in DeploymentGuide.md file