Repository navigation
[docs] Document configured templates in aspire new picker - #2057
Merged
Mitch Denny (mitchdenny) merged 4 commits intoNov 17, 2026
Merged
Mitch Denny (mitchdenny) merged 4 commits into
Mitch Denny (mitchdenny) merged 4 commits into
Conversation
4 of 14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Alistair Matthews (alistairmatthews)
marked this pull request as ready for review
November 5, 2026 16:44
Alistair Matthews (alistairmatthews)
requested review from
David Pine (IEvangelist) and
Mitch Denny (mitchdenny)
as code owners
November 5, 2026 16:44
Contributor
There was a problem hiding this comment.
🟡 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
displayNamevalues 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>
This was referenced Nov 17, 2026
Mitch Denny (mitchdenny)
enabled auto-merge
November 17, 2026 01:05
Mitch Denny (mitchdenny)
approved these changes
Nov 17, 2026
Mitch Denny (mitchdenny)
deleted the
docs/pr-21754-41941578934-1-ef970be50543feac
branch
November 17, 2026 01:22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
Documents the CLI changes from microsoft/aspire#21754 (configured templates in the
aspire newpicker), 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 toaspire template source addandremoveinstead of encouraging direct config-file edits.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, andaspire template source remove.aspire templateto the rootaspirecommand table.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.0CLI source:addtakesname,--path,--repository,--ref, and-y/--yes. It has no display-name option.addfails if the name already exists.listsupports--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(insrc/frontend): passed (18 tests)npx prettier --checkandnpx eslint --max-warnings 0on the sidebar config and new test: passedaspire start --isolated: all seven changed or new command pages return 200 and show the new sidebar entries.