Skip to content

Commit ddb8670

Browse files
authored
Add Guidance main section to README.md (#368)
Add Guidance main section to README.md ## Purpose * Based on @anfibiacreativa feedback, added the Guidance section and contents to the main Readme file. ## Does this introduce a breaking change? <!-- Mark one with an "x". --> ``` [ ] Yes [X] No ``` ## Pull Request Type What kind of change does this Pull Request introduce? <!-- Please check the one that applies to this PR using "x". --> ``` [ ] Bugfix [ ] Feature [ ] Code style update (formatting, local variables) [ ] Refactoring (no functional changes, no api changes) [X] Documentation content changes [ ] Other... Please describe: ``` ## How to Test * Get the code ``` git clone [repo-address] cd [repo-name] ``` ## What to Check Verify that the following are valid * Review Guidance section in the main Readme file.
1 parent c759f29 commit ddb8670

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,10 @@ description: A csharp sample app that chats with your data using OpenAI and AI S
4646
- [Enabling Application Insights](#enabling-optional-features)
4747
- [Enabling authentication](#enabling-authentication)
4848
- [Enable GPT-4V support](#enable-gpt-4v-support)
49-
- [Productionizing](#productionizing)
50-
- [Resources](#resources)
51-
- [FAQ](#faq)
49+
- [Guidance](#guidance)
50+
- [Productionizing](#productionizing)
51+
- [Resources](#resources)
52+
- [FAQ](#faq)
5253

5354
# ChatGPT + Enterprise data with Azure OpenAI and Azure AI Search (.NET)
5455

@@ -346,7 +347,11 @@ azd down --purge
346347
azd env set AZD_PREPDOCS_RAN false # This is to ensure that the documents are re-indexed with the new fields.
347348
```
348349

349-
## Productionizing
350+
## Guidance
351+
352+
Besides the tips below, you can find extensive documentation in the [docs](./docs) folder.
353+
354+
### Productionizing
350355

351356
This sample is designed to be a starting point for your own production application,
352357
but you should do a thorough review of the security and performance before deploying
@@ -366,7 +371,7 @@ to production. Here are some things to consider:
366371

367372
- **Loadtesting**: We recommend running a loadtest for your expected number of users.
368373

369-
## Resources
374+
### Resources
370375

371376
- [Revolutionize your Enterprise Data with ChatGPT: Next-gen Apps w/ Azure OpenAI and Azure AI Search](https://aka.ms/entgptsearchblog)
372377
- [Azure AI Search](https://learn.microsoft.com/azure/search/search-what-is-azure-search)

0 commit comments

Comments
 (0)