[docs] Document ASPIREWATCH001 run mode configuration diagnostic - #1471
[docs] Document ASPIREWATCH001 run mode configuration diagnostic#1471aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
Documents microsoft/aspire#18863, which adds RunConfiguration and the experimental ASPIREWATCH001 diagnostic. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new experimental ASPIREWATCH001 diagnostic so users can understand when it appears and how to suppress it, and wires the page into the diagnostics index and navigation.
Changes:
- Added a new diagnostics page documenting
ASPIREWATCH001, including a usage example and suppression guidance. - Added
ASPIREWATCH001to the diagnostics overview table. - Added
ASPIREWATCH001to the Reference sidebar under Warnings.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/frontend/src/content/docs/diagnostics/overview.mdx | Adds ASPIREWATCH001 to the diagnostics table for discoverability. |
| src/frontend/src/content/docs/diagnostics/aspirewatch001.mdx | New dedicated documentation page for the ASPIREWATCH001 warning. |
| src/frontend/config/sidebar/reference.topics.ts | Adds the new diagnostic page to the sidebar navigation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 32c349b4-907d-42e9-aad8-2f0edc267779
| @@ -0,0 +1,85 @@ | |||
| --- | |||
| title: Compiler Warning ASPIREWATCH001 | |||
| seoTitle: "ASPIREWATCH001: Run mode configuration types and members are for" | |||
There was a problem hiding this comment.
This seoTitle ends mid-sentence at “are for”, so search results will show a truncated title. Could we use a complete title, maybe ASPIREWATCH001: Experimental run mode configuration APIs?
Documents changes from microsoft/aspire#18863
@karolz-msTargeting
release/13.5based on the source PR milestone13.5.Why
microsoft/aspire#18863 adds a new experimental
RunConfigurationtype and aDistributedApplicationExecutionContextOptions.RunConfiguration/DistributedApplicationExecutionContext.RunConfigurationproperty, both marked[Experimental("ASPIREWATCH001", ...)]. This diagnostic previously had no entry on the docs site.What changed
src/frontend/src/content/docs/diagnostics/aspirewatch001.mdx— describes theRunConfigurationclass and itsWatchEnabledproperty, includes a usage example, and documents the standard suppression methods (.editorconfig,NoWarn,#pragma warning disable), following the same structure as the existingASPIREPROBES001page.src/frontend/src/content/docs/diagnostics/overview.mdx— addedASPIREWATCH001to the diagnostics table.src/frontend/config/sidebar/reference.topics.ts— added the new page to the sidebar's Warnings list.No existing pages needed structural changes; this is purely additive.