Skip to content

CLI docs: add aspire resources alias page pointing to aspire describe#1166

Merged
radical merged 3 commits into
mainfrom
copilot/update-aspire-docs-for-describe
Jun 30, 2026
Merged

CLI docs: add aspire resources alias page pointing to aspire describe#1166
radical merged 3 commits into
mainfrom
copilot/update-aspire-docs-for-describe

Conversation

Copilot AI commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Aspire CLI renamed aspire resources to aspire describe, and --watch to --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

    • Added src/frontend/src/content/docs/reference/cli/commands/aspire-resources.mdx as a short alias page.
    • Marks aspire resources as backward-compatible and directs readers to aspire describe.
  • Flag rename guidance

    • Documents the flag transition on the alias page:
      • --watch--follow (-f)
    • Reinforces aspire describe --follow as the preferred usage.
<Aside type="caution" title="Command renamed">
  `aspire resources` is a backward-compatible alias. Use
  [`aspire describe`](/reference/cli/commands/aspire-describe/) as the
  primary command name.
</Aside>

The `--watch` flag was also renamed to `--follow` (`-f`).

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Update docs for aspire resources renamed to aspire describe CLI docs: add aspire resources alias page pointing to aspire describe Jun 2, 2026
Copilot AI requested a review from IEvangelist June 2, 2026 03:03
@IEvangelist IEvangelist marked this pull request as ready for review June 30, 2026 08:38
@IEvangelist IEvangelist requested a review from mitchdenny as a code owner June 30, 2026 08:38
Copilot AI review requested due to automatic review settings June 30, 2026 08:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 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 resources command reference page as an explicit alias/migration handoff to aspire describe.
  • Documented the --watch--follow (-f) flag rename on the alias page.
  • Linked readers directly to the primary aspire describe command documentation.

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

@radical radical enabled auto-merge (squash) June 30, 2026 20:26
@IEvangelist

Copy link
Copy Markdown
Member

Hey @copilot, is this article in the sidebar config? If not, please add it.

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

Copilot AI commented Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

Hey @copilot, is this article in the sidebar config? If not, please add it.

It wasn't — added in 2e9e8c7. The aspire resources entry now appears in reference.topics.ts between aspire resource and aspire restore.

@IEvangelist IEvangelist left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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 resources is a backward-compatible alias. Use aspire describe as the primary command name."
  • Body text renders: "aspire resources command was renamed to aspire describe. Existing scripts that use aspire resources continue to work."
  • Migration guidance renders: "The --watch flag was also renamed to --follow (-f). Use aspire describe --follow for 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.ts change.

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

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1166. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1166 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

@radical radical merged commit 0d2c17e into main Jun 30, 2026
10 checks passed
@radical radical deleted the copilot/update-aspire-docs-for-describe branch June 30, 2026 21:17
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.

CLI: Update docs for 'aspire resources' renamed to 'aspire describe'

4 participants