Skip to content

Comments

Add Developer Experience docs: debugging, startup performance, and hot reload#464

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/debugging-guide-improvements
Draft

Add Developer Experience docs: debugging, startup performance, and hot reload#464
Copilot wants to merge 4 commits intomainfrom
copilot/debugging-guide-improvements

Conversation

Copy link
Contributor

Copilot AI commented Feb 20, 2026

  • Create fundamentals/debug-aspire-apps.mdx - Debugging guide covering VS Code, Visual Studio, Rider, and other IDEs; selective debugging; Linux debugging
  • Create fundamentals/startup-performance.mdx - Performance/startup optimization guide covering NuGet restore, container pull, and app host startup
  • Create fundamentals/hot-reload.mdx - Watch mode/hot reload guide covering current status, limitations, and workarounds
  • Update docs.topics.ts sidebar to include the new pages under Fundamentals
  • Replace <kbd> with <Kbd> component (from starlight-kbd/components) in debug-aspire-apps.mdx
  • Run doc-tester validation — found and fixed two issues:
    • Removed aspire run --no-dashboard (non-existent CLI flag) from startup-performance.mdx
    • Removed misleading WithEnvironment("DOTNET_WATCH", "1") code example from hot-reload.mdx
Original prompt

This section details on the original issue you should resolve

<issue_title>[GitHub Discussions] Developer Experience & Tooling gaps</issue_title>
<issue_description>## Summary

Based on analysis of 820 GitHub discussions from dotnet/aspire.

Question counts:

Topic Questions
DevEx/Tooling 60 total
Performance/Slow 15+
Debugging 10+
IDE Issues 10+
CLI 15+

Critical Gaps

1. ❌ Debugging Guide (CRITICAL)

Discussions:

Customer Questions:

  • Debugging specific services
  • Selective debugging (debug some, not others)
  • Linux-only project debugging
  • Non-VS debugging (Neovim, etc.)

Action Items:

  • Debugging guide (all IDEs)
  • Selective service debugging
  • Linux debugging patterns
  • Non-VS IDE debugging

2. ❌ Performance/Slow Startup (15+ questions)

Discussions:

Customer Questions:

  • NuGet restore taking too long
  • App host startup optimization
  • Container pull slowness

Action Items:

  • Performance optimization guide
  • NuGet restore troubleshooting
  • Startup optimization patterns

3. ⚠️ IDE-Specific Issues

Discussions:

Customer Questions:

  • Rider integration
  • VS Code extension issues
  • GitHub Copilot integration

Action Items:

  • IDE comparison guide
  • Rider-specific documentation
  • VS Code troubleshooting

4. ⚠️ Watch Mode / Hot Reload

No dedicated discussions, but Discord shows high demand (42 questions)

Action Items:

  • Watch mode current status
  • Hot reload limitations
  • Workarounds

Data Source

  • GitHub Discussions: 820 total
  • DevEx-related: 60 discussions
  • Date range: Project inception - February 2026
    </issue_description>

<agent_instructions>Please address this issue, while using the .github/skills/doc-writer/SKILL.md. Be certain to also take into account, related issues, pull requests, and comments that are directly linked as well as comments.</agent_instructions>

Comments on the Issue (you are @copilot in this section)


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

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Add debugging guide for developer experience gaps Add Developer Experience docs: debugging, startup performance, and hot reload Feb 20, 2026
Copilot AI requested a review from IEvangelist February 20, 2026 21:58
Copy link
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

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

This PR looks good so far, but let's double check it for accuracy by using the .github/skills/doc-tester/SKILL.md skill. Please also consider all new comments and feedback. @copilot

<Steps>

1. Install the [Aspire VS Code extension](/get-started/aspire-vscode-extension/).
1. Open the Command Palette (<kbd>Ctrl+Shift+P</kbd> / <kbd>Cmd+Shift+P</kbd>).
Copy link
Member

Choose a reason for hiding this comment

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

Please import the { Kbd } component and use that instead <kbd> throughout this doc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in cf34df5 — imported { Kbd } from starlight-kbd/components and replaced all three <kbd> instances with <Kbd windows='...' mac='...' /> props.

Copilot AI and others added 2 commits February 21, 2026 02:37
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
…ading DOTNET_WATCH example

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 21, 2026

This PR looks good so far, but let's double check it for accuracy by using the .github/skills/doc-tester/SKILL.md skill. Please also consider all new comments and feedback. @copilot

Doc-tester validation complete (823379b). Two issues were found and fixed:

  1. startup-performance.mdx — Removed the "Disable the dashboard for headless scenarios" subsection which referenced aspire run --no-dashboard, a flag that doesn't exist in aspire run (confirmed against the CLI reference docs).

  2. hot-reload.mdx — Removed the misleading WithEnvironment("DOTNET_WATCH", "1") AppHost code example. Setting that env var on a project resource does not invoke dotnet watch or enable hot reload — the correct approach (running dotnet watch run in a separate terminal) is now the sole recommendation in that section.

All internal links, imports, Kbd usage, and other technical claims passed validation.

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.

[GitHub Discussions] Developer Experience & Tooling gaps

2 participants