Skip to content

Enhance Chat App Basics documentation with clearer instructions #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 24, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 19, 2025

This PR improves the documentation in the Chat App Basics section by providing clearer instructions for learners to test the provided code samples.

Changes Made:

  1. Added a "How to run the sample code" section with step-by-step instructions:

    • Prerequisites like GitHub Codespace setup
    • GitHub Token configuration instructions
    • Navigation to sample directories
    • Commands for running applications
  2. Fixed code examples to match actual implementation:

    • Updated method names (.AsChatClient.AsIChatClient)
    • Fixed model name (from gpt-4o-mini to Phi-3.5-MoE-instruct)
    • Corrected property access from response.Message to response.Text
    • Fixed typo in "display the repsonse" to "display the response"
  3. Enhanced "Need help" sections:

    • Added more specific guidance for troubleshooting different parts of the application
    • Updated issue creation links to use the blank issue template
  4. Added helpful cross-references:

    • Links to Ollama setup documentation
    • Pointers to relevant sample code directories

These changes make it easier for learners to follow along with the examples and successfully test the code without confusion.

Fixes #141.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • cdn.fwupd.org
    • Triggering command: /usr/bin/fwupdmgr refresh (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@elbruno
Copy link
Collaborator

elbruno commented May 19, 2025

@copilot also analyze the code quality of this pr

Co-authored-by: elbruno <3533489+elbruno@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Chat App Basics Enhance Chat App Basics documentation with clearer instructions May 19, 2025
@Copilot Copilot AI requested a review from elbruno May 19, 2025 18:33
Copilot finished work on behalf of elbruno May 19, 2025 18:34
Copy link
Contributor Author

Copilot AI commented May 19, 2025

@copilot also analyze the code quality of this pr

The code quality in this PR is excellent. The changes are focused on documentation improvements that enhance the learning experience through several key improvements:

  1. Documentation Accuracy: Code examples were corrected to match the actual API implementation:

    • Changed .AsChatClient to .AsIChatClient which matches the sample implementations
    • Updated property access from response.Message to response.Text in the first example
    • The model name change from gpt-4o-mini to Phi-3.5-MoE-instruct in the first example matches the actual implementation in BasicChat-01MEAI/Program.cs
  2. Consistency: The updates maintain a consistent pattern throughout the document while preserving intentional differences between examples (e.g., different models for different scenarios)

  3. Clarity: Added clear and concise instructions for running each sample with proper formatting and navigation guidance

  4. Usability: Enhanced navigation with cross-references to related content and additional links to setup documentation

  5. Error Handling: Improved troubleshooting guidance with more specific help section links

The PR demonstrates attention to detail by fixing even small typographical errors (like "repsonse" to "response"). The changes are minimal and focused, modifying only what's necessary without introducing new issues.

These documentation improvements will significantly enhance the learning experience by reducing confusion and providing clearer guidance.

Commit hash: 7ae6f28

Copilot finished work on behalf of elbruno May 19, 2025 18:38
Copy link

Check Country Locale in URLs

We have automatically detected added country locale to URLs in your files.
Review and remove country-specific locale from URLs to resolve this issue.

Check the file paths and associated URLs inside them.
For more details, check our Contributing Guide.

File Full Path Issues
README.md
#LinkLine Number
1https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/dall-e?tabs=gpt-image-134
10-WhatsNew/readme.md
#LinkLine Number
1https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/dall-e?tabs=gpt-image-112

1 similar comment
Copy link

Check Country Locale in URLs

We have automatically detected added country locale to URLs in your files.
Review and remove country-specific locale from URLs to resolve this issue.

Check the file paths and associated URLs inside them.
For more details, check our Contributing Guide.

File Full Path Issues
README.md
#LinkLine Number
1https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/dall-e?tabs=gpt-image-134
10-WhatsNew/readme.md
#LinkLine Number
1https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/dall-e?tabs=gpt-image-112

Copy link

Check Broken URLs

We have automatically detected the following broken URLs in your files. Review and fix the paths to resolve this issue.

Check the file paths and associated broken URLs inside them.
For more details, check our Contributing Guide.

File Full Path Issues
02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/160
translations/de/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/pt/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/zh/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/tw/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/fr/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/es/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/ja/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/ko/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
04-PracticalSamples/readme.md
#LinkLine Number
1https://aka.ms/eshoplite/azureaisearch/repo245
2https://aka.ms/eshoplite/AzureAISearch/repo515

1 similar comment
Copy link

Check Broken URLs

We have automatically detected the following broken URLs in your files. Review and fix the paths to resolve this issue.

Check the file paths and associated broken URLs inside them.
For more details, check our Contributing Guide.

File Full Path Issues
02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/160
translations/de/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/pt/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/zh/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/tw/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/fr/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/es/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/ja/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
translations/ko/02-SetupDevEnvironment/getting-started-azure-openai.md
#LinkLine Number
1https://learn.microsoft.com/azure/ai-services/deploy/159
04-PracticalSamples/readme.md
#LinkLine Number
1https://aka.ms/eshoplite/azureaisearch/repo245
2https://aka.ms/eshoplite/AzureAISearch/repo515

@elbruno elbruno marked this pull request as ready for review May 24, 2025 20:22
@elbruno elbruno merged commit 67884d4 into main May 24, 2025
6 of 10 checks passed
@elbruno elbruno deleted the copilot/fix-141 branch May 24, 2025 20:22
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.

Chat App Basics
2 participants