Skip to content

Add Hot Reload and watch guidance#887

Merged
davidfowl merged 5 commits intomainfrom
davidfowl/hot-reload-guidance
May 8, 2026
Merged

Add Hot Reload and watch guidance#887
davidfowl merged 5 commits intomainfrom
davidfowl/hot-reload-guidance

Conversation

@davidfowl
Copy link
Copy Markdown
Contributor

Customers have asked how Hot Reload should work with aspire run, aspire start, and Aspire-managed resources. This PR adds a dedicated AppHost page that explains the current recommended workflow and the boundary between Aspire watch behavior, resource-specific development loops, and IDE-managed hot reload/debugging.

Summary

  • Adds /app-host/hot-reload-and-watch/ with guidance for C# and TypeScript AppHosts using features.defaultWatchEnabled.
  • Clarifies that Aspire CLI watch is restart-based for the AppHost-managed application, not a universal runtime hot reload command.
  • Documents the recommended pattern to keep the AppHost running and restart or rebuild individual resources with aspire resource <resource-name> stop|start|rebuild or dashboard actions.
  • Adds IDE guidance for VS Code, Visual Studio, and Rider, noting that IDE-managed hot reload/debugging does not integrate with Aspire CLI restart, rebuild, or watch behavior.
  • Links the new page from the AppHost sidebar, FAQ, and aspire run / aspire start command reference pages.

Validation

  • Browsed the rendered local page with Playwright.
  • Verified internal links from the new page return 200 locally.
  • Verified aspire config list --all shows defaultWatchEnabled and aspire config set features.defaultWatchEnabled true works.
  • Verified resource command syntax against Aspire CLI help.
  • Ran pnpm --dir .\src\frontend run lint.
  • Ran pnpm --dir .\src\frontend run test:unit:docs.

Document Aspire watch behavior for AppHost changes, resource-specific restart and rebuild workflows, and IDE-managed hot reload/debugging boundaries.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 8, 2026 03:36
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a dedicated documentation page describing how Aspire “watch” relates to AppHost changes, resource-specific dev loops, and IDE-managed Hot Reload/debugging, and links this guidance from relevant CLI reference and FAQ pages.

Changes:

  • Adds a new /app-host/hot-reload-and-watch/ page explaining recommended watch/restart workflows for AppHost vs individual resources (including features.defaultWatchEnabled and aspire resource commands).
  • Updates aspire run and aspire start command reference docs with a “Hot Reload and watch behavior” section linking to the new guidance.
  • Adds an FAQ entry and a sidebar link for discoverability.
Show a summary per file
File Description
src/frontend/src/content/docs/reference/cli/commands/aspire-start.mdx Documents default vs opt-in watch behavior for aspire start and links to the new guidance page.
src/frontend/src/content/docs/reference/cli/commands/aspire-run.mdx Documents default vs opt-in watch behavior for aspire run and links to the new guidance page.
src/frontend/src/content/docs/get-started/faq.mdx Adds an FAQ entry summarizing Aspire watch scope and links to the new guidance page.
src/frontend/src/content/docs/app-host/hot-reload-and-watch.mdx New AppHost page detailing Aspire watch boundaries, resource workflows, and IDE hot reload/debugging behavior.
src/frontend/config/sidebar/docs.topics.ts Adds the new page to the AppHost sidebar topics.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 5/5 changed files
  • Comments generated: 0

Comment thread src/frontend/src/content/docs/app-host/hot-reload-and-watch.mdx
davidfowl and others added 4 commits May 8, 2026 08:30
Document current dotnet watch behavior for Aspire AppHosts and .NET project resources, including restart behavior and known quirks requiring explicit restart or rebuild commands.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Rename the project resources tab to C# projects and tighten the dotnet watch wording around C# project behavior.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Lead the C# projects section with dotnet watch support for C# AppHosts and move current experience quirks into an Important note.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Tighten the C# projects section so dotnet watch support and defaultWatchEnabled behavior are not repeated.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@davidfowl davidfowl merged commit 14eed19 into main May 8, 2026
5 checks passed
@davidfowl davidfowl deleted the davidfowl/hot-reload-guidance branch May 8, 2026 15:58
davidfowl added a commit that referenced this pull request May 8, 2026
* chore: Update integration data and GitHub stats (5/7/26) (#882)

Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Use pnpm instead of npm in check-data-files.mjs (#881)

The repository is configured as a pnpm workspace (pnpm-workspace.yaml,
pnpm-lock.yaml, packageManager: pnpm@10.30.1), but check-data-files.mjs
hardcoded `npm run update:all`. Running npm inside a pnpm workspace
ignores pnpm-lock.yaml, creates an unnecessary package-lock.json, and can
corrupt or destabilize the local development environment.

Fixes #872

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore: Update integration data and GitHub stats (5/8/26) (#890)

Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Add Hot Reload and watch guidance (#887)

* Add Hot Reload and watch guidance

Document Aspire watch behavior for AppHost changes, resource-specific restart and rebuild workflows, and IDE-managed hot reload/debugging boundaries.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Clarify dotnet watch AppHost behavior

Document current dotnet watch behavior for Aspire AppHosts and .NET project resources, including restart behavior and known quirks requiring explicit restart or rebuild commands.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Clarify C# projects watch guidance

Rename the project resources tab to C# projects and tighten the dotnet watch wording around C# project behavior.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Refine C# dotnet watch guidance

Lead the C# projects section with dotnet watch support for C# AppHosts and move current experience quirks into an Important note.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Reduce C# watch guidance repetition

Tighten the C# projects section so dotnet watch support and defaultWatchEnabled behavior are not repeated.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Update standalone dashboard docs for Aspire CLI (#886)

* Update standalone dashboard docs

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Centralize standalone dashboard prerequisites

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Restore dashboard landing quick start

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Address dashboard quick start feedback

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix terminal tabs regression test source

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix standalone dashboard telemetry limits link

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Show both dashboard quick start options

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Address standalone dashboard review feedback

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Copilot AI pushed a commit that referenced this pull request May 9, 2026
* chore: Update integration data and GitHub stats (5/7/26) (#882)

Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Use pnpm instead of npm in check-data-files.mjs (#881)

The repository is configured as a pnpm workspace (pnpm-workspace.yaml,
pnpm-lock.yaml, packageManager: pnpm@10.30.1), but check-data-files.mjs
hardcoded `npm run update:all`. Running npm inside a pnpm workspace
ignores pnpm-lock.yaml, creates an unnecessary package-lock.json, and can
corrupt or destabilize the local development environment.

Fixes #872

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore: Update integration data and GitHub stats (5/8/26) (#890)

Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Add Hot Reload and watch guidance (#887)

* Add Hot Reload and watch guidance

Document Aspire watch behavior for AppHost changes, resource-specific restart and rebuild workflows, and IDE-managed hot reload/debugging boundaries.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Clarify dotnet watch AppHost behavior

Document current dotnet watch behavior for Aspire AppHosts and .NET project resources, including restart behavior and known quirks requiring explicit restart or rebuild commands.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Clarify C# projects watch guidance

Rename the project resources tab to C# projects and tighten the dotnet watch wording around C# project behavior.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Refine C# dotnet watch guidance

Lead the C# projects section with dotnet watch support for C# AppHosts and move current experience quirks into an Important note.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Reduce C# watch guidance repetition

Tighten the C# projects section so dotnet watch support and defaultWatchEnabled behavior are not repeated.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Update standalone dashboard docs for Aspire CLI (#886)

* Update standalone dashboard docs

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Centralize standalone dashboard prerequisites

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Restore dashboard landing quick start

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Address dashboard quick start feedback

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix terminal tabs regression test source

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix standalone dashboard telemetry limits link

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Show both dashboard quick start options

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Address standalone dashboard review feedback

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
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.

3 participants