Repository navigation
[docs] Document template source headings in aspire new picker - #2087
Closed
aspire-repo-bot[bot] wants to merge 1 commit into
Closed
aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit 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. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documentation presents Aspire 17.1 heading formats as available in release/17.0, so it needs a version qualifier or relocation to avoid showing output that the 17.0 CLI cannot produce.
1 open issue
What changed in this PR
Documents the template-source heading changes from microsoft/aspire#21831 in the aspire new CLI reference.
Changes:
- Describes Git repository/ref and directory-path heading formats.
- Adds examples, including the
default branchfallback. - Notes that long headings are cropped to fit the terminal.
| File | Description |
|---|---|
src/frontend/src/content/docs/reference/cli/commands/aspire-new.mdx |
Adds a template source headings section under interactive prompts. |
Review effort: Balanced
|
|
||
| When running `aspire new` in interactive mode, the command asks one or more questions before generating the project. The available prompts depend on the template and options you provide. | ||
|
|
||
| ### Template source headings |
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.

Documents changes from microsoft/aspire#21831
@authorof the source PRTarget branch: Targeting
release/17.0— the latest release branch onmicrosoft/aspire.dev— becauserelease/17.1(from the source PR milestone17.1) does not exist there (target_resolution:latest_release_fallback).Why: The
aspire newtemplate picker now shows the repository and ref (Git) or path (directory) in each template source heading. The docs had no description of this.Changes (updated page):
src/frontend/src/content/docs/reference/cli/commands/aspire-new.mdx: added a "Template source headings" section with theName (repository @ ref),default branch, andName (path)formats and examples.Triggered signals:
cli_command_file_changed,pr_body_has_user_facing_section,pr_body_has_cli_flag_mention.