CLI docs: add aspire resources alias page pointing to aspire describe#1166
Conversation
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
aspire resources alias page pointing to aspire describe
There was a problem hiding this comment.
Pull request overview
Adds a new CLI reference page for the legacy aspire resources command that clearly hands off to aspire describe, aligning the docs with the command/flag rename guidance described in the PR.
Changes:
- Added a new
aspire resourcescommand reference page as an explicit alias/migration handoff toaspire describe. - Documented the
--watch→--follow(-f) flag rename on the alias page. - Linked readers directly to the primary
aspire describecommand documentation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Hey @copilot, is this article in the sidebar config? If not, please add it. |
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
It wasn't — added in 2e9e8c7. The |
IEvangelist
left a comment
There was a problem hiding this comment.
Docs-accuracy review — PR #1166
Source of truth (Phase A): microsoft/aspire @ release/13.3 (SHA 386b6fc0cdaff8024f53f4a87e4586b9bf44581b) — selected because aspire.dev main pins Aspire 13.3.0. Corroborated on main (SHA f5e7a45894822fdee583327518ca6f359828a650); all claims hold identically on both branches. No Community Toolkit or Azure SDK lookups required (this is core CLI surface).
Claims extracted: 4 non-narrative claims — 4 verified, 0 verified-with-nuance, 0 unverifiable, 0 contradicted.
Phase B (doc-tester): Served PR head 89e7c37f via pnpm dev and exercised the new /reference/cli/commands/aspire-resources/ page plus its cross-link target /reference/cli/commands/aspire-describe/. 0 critical, 0 warnings (one Vite dev-only console transient noted below, not a content defect).
Verdict: APPROVE.
Phase A — Claim verification
Every factual assertion the new alias page makes about the Aspire CLI matches DescribeCommand.cs. No contradicted or unverifiable claims, so there are no blocking inline comments.
The key nuance the page gets right: aspire resources (plural) is registered as an alias on the describe command, which is distinct from the separate aspire resource (singular) command — so old scripts keep working, exactly as documented.
Verified claims with evidence (4)
| # | Claim (raw) | Verdict | Evidence (microsoft/aspire @ release/13.3) |
|---|---|---|---|
| 1 | "Use aspire describe as the primary command name." |
verified | DescribeCommand constructor calls base("describe", …) — src/Aspire.Cli/Commands/DescribeCommand.cs:106; registered in RootCommand.cs as DescribeCommand describeCommand |
| 2 | "aspire resources is a backward-compatible alias … Existing scripts that use aspire resources continue to work." |
verified | Aliases.Add("resources"); on the describe command — src/Aspire.Cli/Commands/DescribeCommand.cs:108. (Plural resources is an alias of describe; singular resource is the separate ResourceCommand — no collision.) |
| 3 | "The --watch flag was also renamed to --follow (-f). Use aspire describe --follow for continuous updates." |
verified | s_followOption = new("--follow", "-f") — src/Aspire.Cli/Commands/DescribeCommand.cs:84, added via Options.Add(s_followOption) (line 115). The describe/resources command defines no --watch option (its options are --apphost/--project, --follow/-f, --format, --include-hidden). The only --watch strings remaining in src/Aspire.Cli belong to unrelated surfaces (aspire run --watch, tsc --watch/nodemon in TS templates), so nothing contradicts the rename. |
| 4 | Cross-reference link [aspire describe](/reference/cli/commands/aspire-describe/) (Aside + "See also") |
verified | Target page src/frontend/src/content/docs/reference/cli/commands/aspire-describe.mdx exists in this repo and resolves at runtime (confirmed in Phase B — title "aspire describe command", not a 404) |
The reference.topics.ts sidebar addition is config that mirrors the new file's slug (reference/cli/commands/aspire-resources); it makes no Aspire-source assertion and renders correctly (see Phase B).
Phase B — Doc-tester results
Server: pnpm dev (Astro) at http://localhost:4321/, serving PR head 89e7c37f from a temporary worktree.
Routes exercised: /reference/cli/commands/aspire-resources/ (the new page) and /reference/cli/commands/aspire-describe/ (its cross-link target). Scope limited to what this PR's diff touches.
Critical issues: none.
Passed checks:
- New page renders with H1 "aspire resources command" and page title "aspire resources command | Aspire".
- The "Command renamed" caution
<Aside>renders as a callout: "aspire resourcesis a backward-compatible alias. Useaspire describeas the primary command name." - Body text renders: "
aspire resourcescommand was renamed toaspire describe. Existing scripts that useaspire resourcescontinue to work." - Migration guidance renders: "The
--watchflag was also renamed to--follow(-f). Useaspire describe --followfor continuous updates." - All three links to
aspire describe(inline in the Aside, the body, and "See also") point to/reference/cli/commands/aspire-describe/and the target page loads successfully (not a 404). - Sidebar lists "aspire resources" immediately after "aspire resource" under the CLI commands group, matching the
reference.topics.tschange.
Warnings / knowledge gaps: none affecting content. One non-blocking observation: both pages logged a single dev-server console error — 504 (Outdated Optimize Dep) for astro/runtime/client/dev-toolbar/entrypoint.js. This is a Vite dependency-optimization transient from the local pnpm dev toolbar and is unrelated to the PR's content (it appears on the unchanged aspire-describe page too). A separate build-log WARN about a duplicate deployment/kubernetes id is pre-existing and unrelated to this PR. Both are out of scope (CI/dev-tooling).
Reviewed automatically by the doc-pr-reviewer skill (Phase A: source-of-truth claim verification against microsoft/aspire; Phase B: doc-tester against the locally served PR).
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Aspire CLI renamed
aspire resourcestoaspire describe, and--watchto--follow/-f. This PR aligns the docs by making the old command page an explicit alias handoff to the new primary command name.CLI reference updates
src/frontend/src/content/docs/reference/cli/commands/aspire-resources.mdxas a short alias page.aspire resourcesas backward-compatible and directs readers toaspire describe.Flag rename guidance
--watch→--follow(-f)aspire describe --followas the preferred usage.