Repository navigation
[docs] Document global template sources in the CLI - #1974
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
docs-pr-reviewer report — [partial — phase A: key claims evaluated; phase B: not run (docs site was not served in this automated run)]Recommendation: approve Source used: microsoft/aspire#21329 (merged 2026-10-29) Phase A — claims
Phase B — doc-testerNot run; rendering of the changed pages is not browser-checked. 🤖 Posted by aspire.dev - squad (AI Agent) |
There was a problem hiding this comment.
🟡 Changes recommended
The CLI synopsis incorrectly makes --path and --repository mutually exclusive and presents --ref as valid for local sources, contradicting the documented usage.
1 open issue
What changed in this PR
Documents global template sources introduced in Aspire 17.0, adding CLI reference pages and explaining how users discover configured templates through aspire new.
Changes:
- Add command references for managing template sources, including configuration and examples.
- Describe the interactive Search for more templates flow and option restrictions.
- Add sidebar navigation for the new command pages.
| File | Description |
|---|---|
src/frontend/src/content/docs/reference/cli/commands/aspire-template.mdx |
Introduces the template command group. |
src/frontend/src/content/docs/reference/cli/commands/aspire-template-source.mdx |
Documents source management commands, options, and configuration. |
src/frontend/src/content/docs/reference/cli/commands/aspire-new.mdx |
Explains searching configured template sources. |
src/frontend/config/sidebar/reference.topics.ts |
Adds navigation entries for both new references. |
Review effort: Balanced
| ## Synopsis | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire template source add <name> (--path <path> | --repository <url>) [--ref <ref>] [options] |
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>
|
Closing in favor of #2057, which consolidates these template source docs with the |
## 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 #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 #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.

Documents changes from microsoft/aspire#21329
Author:
@mitchdenny(source PR author/actor)Target branch: Targeting
release/17.0based on the source PR milestone17.0(exact_match).Why
The source PR adds
aspire template source add|remove|listand a "Search for more templates" flow inaspire new, with a new globaltemplateSourcesconfig key. None of this was documented.Changes
New pages:
reference/cli/commands/aspire-template.mdxreference/cli/commands/aspire-template-source.mdxUpdated:
reference/cli/commands/aspire-new.mdx(new "Search for more templates" section)config/sidebar/reference.topics.ts(sidebar entries)Triggered signals: cli_command_added, cli_command_file_changed, cli_option_added, cli_resource_strings_changed, pr_body_has_cli_flag_mention, pr_body_has_user_facing_section.