Skip to content

[docs] Document configured templates in aspire new picker - #2057

Merged
Mitch Denny (mitchdenny) merged 4 commits into
release/17.0from
docs/pr-21754-41941578934-1-ef970be50543feac
Nov 17, 2026
Merged

Mitch Denny (mitchdenny) merged 4 commits into
release/17.0from
docs/pr-21754-41941578934-1-ef970be50543feac

Conversation

@aspire-repo-bot

@aspire-repo-bot aspire-repo-bot Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documents the CLI changes from microsoft/aspire#21754 (configured templates in the aspire new picker), together with the related template-source command reference. This PR now consolidates #1974 and #1983, which are being closed in favor of this one.

  • aspire new: new Select a template section that describes the grouped picker, entry labels, truncation, and search behavior. A Configure template sources subsection links to aspire template source add and remove instead of encouraging direct config-file edits.
  • New reference pages: aspire template, aspire template source, aspire template source add (trust confirmation and --yes, from [docs] Document trust confirmation for aspire template source add #1983), aspire template source list, and aspire template source remove.
  • Registers the new pages under an aspire template group in the CLI reference sidebar, and adds aspire template to the root aspire command table.
  • Adds cli-command-sidebar.vitest.test.ts (from [docs] Document trust confirmation for aspire template source add #1983), which ensures that every CLI command page appears in the sidebar.

Validated against the release/17.0 CLI source:

  • add takes name, --path, --repository, --ref, and -y/--yes. It has no display-name option.
  • Source names must be 1–64 ASCII letters, digits, dots, hyphens, or underscores, starting with a letter or digit.
  • add fails if the name already exists.
  • list supports --format.

#1974's "Search for more templates" section was dropped because #21754 replaced it with the grouped picker.

Third-party links and affiliations

None

Validation

  • npx vitest run --config vitest.config.ts tests/unit/cli-command-sidebar.vitest.test.ts tests/unit/seo-lengths.vitest.test.ts tests/unit/cli-config-schema.vitest.test.ts (in src/frontend): passed (18 tests)
  • npx prettier --check and npx eslint --max-warnings 0 on the sidebar config and new test: passed
  • Live preview via aspire start --isolated: all seven changed or new command pages return 200 and show the new sidebar entries.

@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Nov 5, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

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

VS Code: Open PR #2057 artifacts

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

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.

🟡 Changes recommended

The documentation needs to scope picker behavior and configured-source discovery accurately, and distinguish space-only fallback values from tabs or newlines that fail validation.

2 open issues
What changed in this PR

Documents the configured-template picker introduced in microsoft/aspire#21754 in the existing aspire new CLI reference for Aspire 17.0.

Changes:

  • Describes configured-source grouping, template labels, truncation, and search behavior.
  • Explains source aliases and optional displayName values with JSON and CLI configuration examples.
File Description
src/​frontend/​src/​content/​docs/​reference/​cli/​commands/​aspire-new.mdx Adds template-selection guidance and source display-name configuration examples.

Review effort: Balanced

Bring the aspire template, aspire template source, and aspire template
source add reference pages from #1974 and #1983 into this PR, add list
and remove pages, and register them in the CLI sidebar. Validate content
against the release/17.0 CLI: drop the superseded "Search for more
templates" picker section, use the 1-64 character source name rule, and
note that add fails for existing names.

In aspire new, replace the displayName guidance with links to the
aspire template source add and remove commands.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@mitchdenny
Mitch Denny (mitchdenny) merged commit 206f89d into release/17.0 Nov 17, 2026
17 checks passed
@mitchdenny
Mitch Denny (mitchdenny) deleted the docs/pr-21754-41941578934-1-ef970be50543feac branch November 17, 2026 01:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants