Skip to content

Improve clarity and user guidance in the Teleprompter Console App tutorial #47137

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 5 commits into from
Jul 15, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 8, 2025

Summary

This PR implements several improvements to the Teleprompter Console App tutorial based on user feedback in issue #25876. The changes focus on making the tutorial clearer and more user-friendly, particularly around the async programming sections where users reported confusion.

Changes Made

1. Enhanced dotnet new console example

Added a concrete command prompt example showing the complete interaction:

E:\development\VSprojects>mkdir teleprompter
E:\development\VSprojects>cd teleprompter
E:\development\VSprojects\teleprompter>dotnet new console
The template "Console Application" was created successfully.
...

2. Improved async Task flow explanation

  • Moved the paragraph about creating the RunTeleprompter task to the appropriate section where it's actually implemented
  • Changed "Write one final Task..." to "Create a RunTelePrompter task..." for clarity

3. Better TelePrompterConfig.cs file creation guidance

  • Added specific filename suggestion: "For example TelePrompterConfig.cs"
  • Included the using static System.Math; statement directly in the code block
  • Updated wording from "You'll also need to add a using static statement..." to "Note the using static statement allows you to..."

4. Enhanced method parameter explanation

Added clarification about the config object parameter passing:

"The config object is being passed as a parameter to these methods. Use copy/paste to completely replace the methods with the new code here. You can see the code is using attributes and calling methods from the config object."

5. Removed confusing content

Removed the potentially confusing sentence: "This new version of ShowTeleprompter calls a new method in the TeleprompterConfig class."

Impact

These changes address the specific pain points mentioned in the issue where users missed parameter changes and had difficulty following the async programming flow. The tutorial now provides clearer step-by-step guidance with concrete examples and better explanations of the code structure.

Fixes #25876


💡 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.


Internal previews

📄 File 🔗 Preview link
docs/csharp/tutorials/console-teleprompter.md Console app

@BillWagner
Copy link
Member

@copilot Please start working on this again

@BillWagner
Copy link
Member

@copilot Can you start working on this again?

@BillWagner
Copy link
Member

@copilot Can you start working on this again?

@Copilot Copilot AI changed the title [WIP] Suggestions for improving the Teleprompter Console App tutorial Improve clarity and user guidance in the Teleprompter Console App tutorial Jul 10, 2025
Copilot finished work on behalf of BillWagner July 10, 2025 20:33
@dotnet-policy-service dotnet-policy-service bot added the okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. label Jul 10, 2025
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM. I'll mark it ready for final review.

@BillWagner BillWagner marked this pull request as ready for review July 14, 2025 18:42
@BillWagner BillWagner requested a review from a team as a code owner July 14, 2025 18:42
@BillWagner BillWagner requested a review from IEvangelist July 14, 2025 18:42
Copilot finished work on behalf of BillWagner July 14, 2025 18:47
@Copilot Copilot AI requested a review from BillWagner July 14, 2025 18:47
@BillWagner BillWagner enabled auto-merge (squash) July 15, 2025 18:49
@BillWagner BillWagner merged commit fee9fe7 into main Jul 15, 2025
10 checks passed
@BillWagner BillWagner deleted the copilot/fix-25876 branch July 15, 2025 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet-csharp/svc fundamentals/subsvc okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Suggestions for improving the Teleprompter Console App tutorial
3 participants