[docs] Add HTTPS dev certificate guidance to TypeScript AppHost docs#1032
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Open
[docs] Add HTTPS dev certificate guidance to TypeScript AppHost docs#1032aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
TypeScript (and other polyglot) app host users may not have the .NET SDK on their PATH, so `dotnet dev-certs https --trust` guidance doesn't apply. Aspire now surfaces `aspire certs trust` in HTTPS error messages for polyglot hosts (microsoft/aspire#17348). Add an 'HTTPS development certificates' section to the TypeScript AppHost project structure page explaining how to resolve the error with `aspire certs trust`, with a tip for clean+trust recovery and a cross- reference to the full certificate-configuration docs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing documentation for TypeScript (polyglot) AppHost users who hit HTTPS dev-certificate failures when running aspire run, aligning guidance with the newer CLI error message that recommends aspire certs trust.
Changes:
- Added an “HTTPS development certificates” section to the TypeScript AppHost docs explaining when/why the error occurs.
- Documented remediation using
aspire certs trust, plus a recovery flow usingaspire certs cleanfollowed byaspire certs trust. - Added cross-links to certificate configuration docs and the
aspire certs trustcommand reference.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
This PR documents how TypeScript (polyglot) AppHost users should resolve HTTPS development certificate errors when running
aspire run.Context
Aspire PR microsoft/aspire#17348 improved the error messages for polyglot (TypeScript/Node.js/Python) app host users encountering Kestrel HTTPS dev-cert failures. Previously, the error pointed to
dotnet dev-certs https --trust, which requires the .NET SDK on the user's PATH — not a given for TypeScript AppHost users. The PR now rewrites that error message to recommendaspire certs trustinstead.The missing piece in the docs is guidance on this certificate step specifically for TypeScript AppHost users. The
typescript-apphost.mdxpage had no mention of HTTPS certificate setup.Changes
src/frontend/src/content/docs/app-host/typescript-apphost.mdx— added an "HTTPS development certificates" section explaining:aspire certs trustaspire certs clean+aspire certs trustaspire certs trustandCertificate configurationto the See Also linksTriggered signals
pr_body_has_cli_flag_mention— source PR body mentions--trustindotnet dev-certs https --trustSource PR
Closes documentation gap surfaced by microsoft/aspire#17348.