Add multi-language integrations guide#558
Merged
IEvangelist merged 8 commits intorelease/13.2from Mar 19, 2026
Merged
Conversation
New doc explaining how integration authors export their APIs for TypeScript AppHosts using [AspireExport], [AspireDto], [AspireExportIgnore], and [AspireUnion] attributes. Covers the analyzer (ASPIREEXPORT001-010), local development with project references in aspire.config.json, third-party attribute definitions, and a supported types reference. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
davidfowl
force-pushed
the
multi-language-authoring
branch
from
ce9223b to
8b3d490
Compare
davidfowl
changed the title
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
IEvangelist
approved these changes
Mar 19, 2026
Member
IEvangelist
left a comment
IEvangelist
left a comment
There was a problem hiding this comment.
Great start! I have several questions, nits, and suggestions.
| </PackageReference> | ||
| ``` | ||
|
|
||
| The analyzer reports 10 diagnostics (ASPIREEXPORT001–010) that help you get your exports right before users encounter runtime errors. |
Member
There was a problem hiding this comment.
I don't think we should explicitly call out the number of diagnostics, as that's fragile. Instead, say more generically that there are a number of diagnostics available, and perhaps detail some of the common scenarios these diagnostics cover/handle.
We'll also need to add these diagnostic articles to the existing /diagnostics/overview/ and create a new article per diagnostic following the existing patterns.
It also seems like we need a ASPIREATS001 diag article too.
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx
Outdated
Show resolved
Hide resolved
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx
Outdated
Show resolved
Hide resolved
Member
There was a problem hiding this comment.
Since this arrticle falls under the extensibility node in the sidebar, we should link to it from the other TypeScript AppHost articles.
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx
Outdated
Show resolved
Hide resolved
| // Your existing implementation... | ||
| } | ||
|
|
||
| [AspireExport] |
Member
There was a problem hiding this comment.
We should have an example that uses ExposeMethods and ExposeProperties set to true, detailing what they are/what they do and when to use them. In fact, there are several other properties on this attribute that should be detailed.
Contributor
There was a problem hiding this comment.
Most resources should have ExportProperties = true
|
|
||
| ## Third-party integrations | ||
|
|
||
| If your integration doesn't reference `Aspire.Hosting` directly (or you want to avoid a version dependency on the attribute types), you can define your own copies of the ATS attributes. The scanner discovers attributes by **full type name**, not by assembly reference. |
Member
There was a problem hiding this comment.
Curious about this, how can you be an Aspire hosting integration without depending on Aspire.Hosting? Also, if this is such a concern - why not leave the abstractions, attributes, etc. in their own separate assembly?
Contributor
Author
There was a problem hiding this comment.
Yea, tbh this isn't interesting to add, it's an implementation detail.
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx
Show resolved
Hide resolved
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx
Outdated
Show resolved
Hide resolved
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx
Outdated
Show resolved
Hide resolved
IEvangelist
reviewed
Mar 19, 2026
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: David Pine <david.pine@microsoft.com>
…language integration authoring guide
Member
|
Hey @copilot, could you please update this PR to include new articles for the missing diagnostics that are called out? |
Contributor
|
@IEvangelist I've opened a new pull request, #560, to work on those changes. Once the pull request is ready, I'll request review from you. |
| Add `[AspireExport]` to your `Add*`, `With*`, and `Run*` extension methods. The attribute takes a method name that becomes the TypeScript API: | ||
|
|
||
| ```csharp title="C# — MyDatabaseBuilderExtensions.cs" | ||
| #pragma warning disable ASPIREATS001 // ATS types are experimental |
Contributor
There was a problem hiding this comment.
Maybe suggest to discard this warning in the csproj?
| | **Special** | `ParameterResource`, `ReferenceExpression`, `EndpointReference`, `CancellationToken` | | ||
| | **Nullable** | Any of the above as nullable (`T?`) | | ||
|
|
||
| Types that are **not** ATS-compatible include: `Action<T>`, `Func<T>`, `IConfiguration`, `ILogger` (unless explicitly exported), interpolated string handlers, and custom complex types without `[AspireExport]` or `[AspireDto]`. |
Contributor
There was a problem hiding this comment.
Isn't that mostly wrong statements?
Most delegates are compatible. ILogger and even IServiceProvider are already exported. We might have some exports today that were not because of these, but we'll revisit them in 13.2.1 or 13.3 because in the meantime it has been aded.
Also Action maybe require the RunAsBackgroundSoemthing when it's invoked inline (and not referenced as a later callback)
- Don't hardcode diagnostic count, describe scenarios generically - Show NoWarn in csproj instead of #pragma for ASPIREATS001 - Add ExposeProperties/ExposeMethods examples (per sebastienros) - Fix supported types: delegates, ILogger, IServiceProvider are compatible - Remove Third-party integrations section (implementation detail per davidfowl) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…tegrations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
eerhardt
added a commit
that referenced
this pull request
Mar 23, 2026
* Add WithBun() documentation to JavaScript integration page (#289) * Initial plan * Add WithBun() documentation to JavaScript integration page Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update Bun example to use specific version tag Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add documentation for deployment slot support in Azure App Service (#290) * Initial plan * Add documentation for deployment slot support to Azure App Service Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add Azure integrations documentation and CLI command references - Created documentation for Azure Application Insights integration. - Created documentation for Azure Data Explorer (Kusto) integration. - Created documentation for Azure Log Analytics integration. - Created documentation for Azure Data Lake Storage integration. - Added `aspire doctor` command placeholder with redirect to main CLI command page. - Added documentation for `aspire ps` command to list running AppHost processes. - Added documentation for `aspire stop` command to stop running AppHost processes. * Remove run_git_commands.ps1 script and associated documentation for CLI commands and diagnostics * Remove obsolete aspire-doctor documentation as it is covered by PR #270 * Update VSCode settings for Prettier and enhance troubleshooting documentation * Add new diagnostic topic for container shell execution * Add new diagnostic topics for .NET tool and extensions * Update ASPIRE008 diagnostic page for GenerateAssemblyInfo requirement (#288) * Initial plan * Update ASPIRE008 diagnostic page for GenerateAssemblyInfo requirement Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update project file samples to modern 13.x format Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add note about search functionality during local development in contributor guide * Add polyglot AppHost documentation for TypeScript, Python, Go, Rust, … (#277) * Add polyglot AppHost documentation for TypeScript, Python, Go, Rust, and Java * feat: enhance PivotSelector component with marginTop prop for better layout control (#302) docs: update Polyglot AppHost documentation with new features and usage examples docs: add link to Polyglot AppHost in resource model documentation docs: include Polyglot AppHost reference in get-started guide for broader language support style: import utility classes for padding and margin in site CSS style: create utils.css for reusable padding and margin utility classes * fix: format project structure in polyglot AppHost documentation for clarity --------- Co-authored-by: David Pine <david.pine@microsoft.com> * Add translation guide and related assets for aspire.dev - Created a new translation guide document in MDX format to assist contributors in translating the aspire.dev documentation. - Added two new images for the translation page link and language selector in both light and dark themes. - Included a detailed section on supported languages, translation status, best practices, and tips for translators. * feat: enhance footer with preferences and social icons - Added FooterPreferences component for user preferences (theme, language, keyboard shortcuts). - Introduced FooterSocials component to display social media links. - Updated Footer.astro to include new components and adjusted layout for preferences. - Enhanced Header.astro to remove theme and language selectors, now located in the footer. - Implemented auto-detection of user language on first visit in Head.astro. - Adjusted styles for new components and improved responsiveness. - Updated translations in various languages to include "preferences". * fix: update package manager version to pnpm@10.28.2 * Refactor Head.astro component and update CSS styles - Changed hideOnClick prop in Head.astro from 'toggle' to true for improved clarity. - Removed fixed width and height from .starlight-sidebar-topics-icon to allow for flexible sizing. - Adjusted icon size in .social-icons and .starlight-sidebar-topics-icon for consistency and better responsiveness. * chore: update package overrides for seroval and lodash-es in package.json and pnpm-lock.yaml * fix: update links and references in translation guide and configuration files * fix: add border to cookie consent button and remove button transform effects * fix: reduce icon sizes in IntegrationCard component for better layout * fix: update cookies.svg icon design and adjust FooterSocials component styling * fix: update project name in deployment guide from AspireApp to AspireDeploy * feat: add Aspire 13.2 release notes and update sidebar links for new version * fix: update code block syntax for Azure CLI commands in deployment guide * feat: add header link styles and hover effects for improved navigation * Document .NET tool support for Aspire 13.2 (#310) * Initial plan * Add documentation for .NET tool resources Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * feat: update compiler warning documentation for ASPIREDOTNETTOOL and ASPIREEXTENSION001 with version notes and suppression methods * fix: remove .NET specific content * chore: filter NuGet descriptions, ensuring we correctly handle .NET Aspire instances * feat: update diagnostic documentation for ASPIRECONTAINERRUNTIME001, ASPIRECONTAINERSHELLEXECUTION001, ASPIREPIPELINES004, ASPIREPOSTGRES001, and ASPIREUSERSECRETS001 with improved descriptions and examples * fix: update star count for dotnet/aspire-samples in GitHub stats * feat: update documentation and configuration for improved clarity and consistency across various components * fix: update translation status dashboard link in CONTRIBUTING.md * fix: remove .NET prefix from Aspire documentation descriptions for consistency * feat: update header component with improved button styles and mobile responsiveness * Add CLI telemetry details page (#362) * Clarify Azure AI Foundry format parameter documentation (#313) * Initial plan * Improve Azure AI Foundry format parameter documentation Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Configure WAF on the Azure Front Door (#324) * Configure WAF on the Azure Front Door These policies are required by Microsoft to prevent DDOS attacks on the site. * Fix invalid wafPolicy name * Update resource creation in Node.js docs (#333) Correction to invalid syntax. * Add generic "Upgrade Aspire" article under What's new (#322) * Initial plan * Add Upgrade Aspire article and update sidebar configuration Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix typo and remove broken link in Upgrade Aspire article Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * refactor: streamline Upgrade Aspire article and remove legacy content * fix: update Upgrade Aspire article for clarity and accuracy * chore: remove outdated setup and tooling link from Upgrade Aspire article * fix: update link to installation instructions for Aspire CLI in Upgrade Aspire article * fix: clarify upgrade instructions and remove outdated content in Upgrade Aspire article --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * Add CLI telemetry details page * Fix * Fix * Fix * Improve doc-tester and doc-writer skills, fix cross-platform paths (#361) * Add doc-writer and doc-tester skills with hex1b MCP server - Add doc-writer skill with Aspire documentation guidelines - Add doc-tester skill for validating documentation accuracy - Include common documentation rules from PR feedback patterns - Configure hex1b MCP server in .mcp.json, .vscode/mcp.json, opencode.jsonc - Add .doc-tester-workspace/ to .gitignore - Add .vscode/mcp.json exception to .gitignore * Improve doc-tester and doc-writer skills, fix cross-platform paths Key changes: doc-tester skill: - Add Knowledge Source Awareness section to distinguish between intrinsic knowledge and documentation-derived knowledge - Add Documentation Takes Priority guidance - follow the docs being tested, not skill defaults - Add Aspire CLI installation guidance (GA, Dev, PR, and Staging builds) - Replace dotnet-specific commands with polyglot-friendly Aspire CLI (aspire add, aspire run) - Add Hex1b MCP tools section for terminal screenshots and asciinema recordings doc-writer skill: - Add AsciinemaPlayer component documentation for terminal recordings - Add Hex1b MCP tools guidance for creating new recordings - Add Aspire CLI installation guidance for testing documentation - Add aspire add recommendation for testing integration packages Other fixes: - Update Prettier extension recommendation to esbenp.prettier-vscode - Fix cross-platform path in frontend.esproj (backslash to forward slash) * Update Hex1b.McpServer to 0.66.0 --------- Co-authored-by: Mitch Denny <mitch@mitchdeny.com> * Fix PowerShell syntax in telemetry opt-out example --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com> Co-authored-by: Tristan <Tri125@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> Co-authored-by: Mitch Denny <midenn@microsoft.com> Co-authored-by: Mitch Denny <mitch@mitchdeny.com> * feat: add new sidebar topics for pipelines and app lifecycle guide with translations * feat: enhance styling for action buttons with border-radius * Rename 'aspire mcp' CLI reference docs to 'aspire agent' (#415) * Initial plan * Rename aspire mcp to aspire agent in CLI reference docs Co-authored-by: mitchdenny <513398+mitchdenny@users.noreply.github.com> * Final documentation updates complete Co-authored-by: mitchdenny <513398+mitchdenny@users.noreply.github.com> * Revert unrelated changes to aspire-integrations.json Co-authored-by: mitchdenny <513398+mitchdenny@users.noreply.github.com> * Add redirects for renamed aspire-mcp CLI pages The old aspire-mcp URLs are live on aspire.dev. Without redirects, merging the rename would break existing links from search engines, bookmarks, and external documentation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update mcp-init.cast recording to show 'aspire agent init' Replace the typed command from 'aspire mcp init' to 'aspire agent init' with realistic human typing delays. All other content unchanged. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rename mcp-init.cast to agent-init.cast Update filename and all references to match the renamed command. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: mitchdenny <513398+mitchdenny@users.noreply.github.com> Co-authored-by: Mitch Denny <mitch@mitchdeny.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add migration guidance for IAzureContainerRegistry obsolete breaking change (#416) Expand the breaking change section in aspire-13-2.mdx with: - Explanation of why the interface was deprecated - Full before/after code examples including ManagedIdentityId - Note about managed identity handling changes Update azure-container-registry.mdx with: - New section showing ContainerRegistry property access pattern - Deprecation notice linking to the breaking changes section Fixes #414 Co-authored-by: Mitch Denny <mitch@mitchdeny.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: document image pull policy and Docker Compose PullPolicy (#417) * docs: document image pull policy and Docker Compose PullPolicy Add reference documentation for the ImagePullPolicy API and Docker Compose PullPolicy property (Aspire 13.2 features). - Add 'Configure image pull policy' section to docker.mdx with enum values, WithImagePullPolicy() usage, Never policy example, and Compose mapping - Add 'Pull policy' section to docker-compose-to-apphost-reference.mdx with pull_policy mapping table - Add cross-reference links from aspire-13-2.mdx what's-new entries Closes microsoft/aspire.dev#411 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: correct PublishAsDockerComposeService calls to include required configure parameter The PublishAsDockerComposeService API has always required an Action<DockerComposeServiceResource, Service> configure callback. The parameterless overload shown in docs never existed in the Aspire API. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: remove unnecessary PublishAsDockerComposeService from examples All resources are automatically published as Docker Compose services when a DockerComposeEnvironment is present. PublishAsDockerComposeService is only needed to customize the generated service definition. - Remove PublishAsDockerComposeService from intro, push, and registry examples - Add dedicated 'Customize a Docker Compose service' section showing the correct usage with a meaningful customization example Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Mitch Denny <mitch@mitchdeny.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: Add import/export telemetry data documentation for dashboard (#418) * docs: add import/export telemetry data documentation Add documentation for the new Manage logs and telemetry dialog in the Aspire dashboard, which enables users to export, import, and remove telemetry data across resources. - Add new 'Manage data' subsection under 'Interact with telemetry' - Document export flow (ZIP with OTLP JSON, console logs, resources) - Document import flow (.zip and .json files, 100 MB limit) - Document granular remove via the Manage dialog - Update 'Remove data' section to reference new Manage dialog - Update Settings dialog description - Add dark-theme screenshots: manage-data-dialog, manage-data-expanded, settings-manage-telemetry - Update remove-all-telemetry screenshot (now shows Manage button) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: update screenshots to current dashboard UI - Update pause-telemetry.png with current Console logs page showing paused state with log content and 'Log capture paused' message - Update remove-telemetry-data.png with current Structured logs page showing Remove dropdown with current UI styling - Remove unused remove-all-telemetry.png (duplicate of settings-manage-telemetry.png after Settings dialog redesign) - Remove dead import for removeAllTelemetry in explore.mdx Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Mitch Denny <mitch@mitchdeny.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: update package overrides for lodash, fast-xml-parser, and seroval * Implement feature X to enhance user experience and optimize performance * Refactor code structure for improved readability and maintainability * Add "Agentic Control Plane" card to homepage swimlane (#404) * Documenting DCPCliPath (#380) * Add missing namespace (#386) `IDistributedApplicationEventingSubscriber` is in `using Aspire.Hosting.Lifecycle` * Update devtunnel CLI installation link to correct URL (#382) * Update devtunnel CLI installation link to correct URL * Apply suggestion from @IEvangelist --------- Co-authored-by: David Pine <david.pine@microsoft.com> * Explain how to start & stop resources manually (#381) * Replace Hex1b MCP server with Hex1b.Tool CLI (#387) * Replace Hex1b MCP server with Hex1b.Tool CLI - Remove hex1b MCP server configs from .mcp.json, .vscode/mcp.json, opencode.jsonc - Add hex1b skill file generated by 'hex1b agent init' - Update doc-writer skill to reference hex1b CLI commands - Update doc-tester skill to reference hex1b CLI commands * Address PR feedback: fix install command, recording example, and key names - Fix install command to specify --global or --local scope - Add --output to recording start example in doc-tester - Fix ArrowUp → UpArrow to match Hex1bKey enum - Expand key name list to include all Hex1bKey enum values --------- Co-authored-by: Mitch Denny <mitch@mitchdeny.com> * Add agentic control plane card and rearrange homepage layout --------- Co-authored-by: Jose Perez Rodriguez <joperezr@microsoft.com> Co-authored-by: Alex Crome <afscrome@users.noreply.github.com> Co-authored-by: Alex Ravenna <alex.n.ravenna@gmail.com> Co-authored-by: David Pine <david.pine@microsoft.com> Co-authored-by: David Bottiau <bottiau.david@laposte.net> Co-authored-by: Mitch Denny <midenn@microsoft.com> Co-authored-by: Mitch Denny <mitch@mitchdeny.com> * Update polyglot article for TypeScript-only coverage (#402) Addresses #397: - Use aspire new -l typescript --name my-apphost as primary command - Keep aspire init as a tip for existing directories - Replace Redis-only example with Redis + Azure Storage integrations - Add section showing how to add a JavaScript application - Use $HOME for PowerShell log paths - Remove all non-TypeScript languages (Python, Go, Rust, Java) - Simplify mermaid diagram to TypeScript only - Consolidate prerequisites into single table * fix: update related command links in MCP configuration documentation * fix: update links and improve formatting in index documentation * Redesign the welcome page to be more engaging (#429) * feat: update GitHub stars and add new components for enhanced UI - Updated star counts for existing GitHub projects in github-stats.json. - Added CTABanner component for call-to-action sections. - Introduced FeatureShowcase component to display features dynamically. - Created HeroSection component for the main hero area with particle effects. - Implemented QuickStartJourney component to guide users through steps. * refactor: update color variables and accent options across components for consistency * fix: enhance descriptions for AppHost, resources, and deployment sections in documentation * fix: standardize import formatting and improve header structure * feat: add new components and documentation for Aspire Dashboard and deployment (#442) - Introduced ImageShowcase, TerminalShowcase, and TopicHero components for enhanced UI. - Created documentation for Aspire Dashboard, detailing features, capabilities, and AI-powered debugging. - Added deployment documentation covering deployment processes, integrations, and diagnostics. - Included integration documentation for connecting to various services and managing diagnostics. * fix: update banner content to reflect Aspire 13.2 release details * feat: update starlight-page-actions to version 0.5.0 and enable sharing feature * feat: enhance TopicHero component with additional accent colors and update styles for better consistency * fix: format secondary CTA props for consistency in diagnostics documentation * Refactor documentation for multiple languages: update imports, improve phrasing, and enhance clarity in Japanese, Korean, Portuguese (Brazil and Portugal), Russian, Turkish, Ukrainian, and Chinese (Simplified) sections. * fix: update minimatch and balanced-match dependencies for compatibility * Add Azure Virtual Network integration documentation (#401) * Add Azure Virtual Network integration documentation * Update to use AzureServiceTags * chore: address UX feedback from peer review. Add CTA for socials, remove posts page, fold diagnostics into ref (#446) * Update Aspire 13.2 what's new article with accurate content (#441) * Initial plan * Update Aspire 13.2 what's new article based on Gist content Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix heading case to sentence case and add LearnMore links for CLI commands Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add title attributes to CLI code blocks for better context Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Change code block titles from "Bash" to "Aspire CLI" Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add emoji prefixes to all h2 section headings Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add footer X follow link and update docs content (#448) * Add CLI documentation for aspire docs commands - Created `aspire-docs-get.mdx` to document the `aspire docs get` command, detailing its usage, options, and examples. - Created `aspire-docs-list.mdx` to document the `aspire docs list` command, including its options and examples for listing available documentation pages. - Created `aspire-docs-search.mdx` to document the `aspire docs search` command, explaining how to search documentation by keywords and its options. - Created `aspire-docs.mdx` to serve as an overview for the `aspire docs` command, summarizing its functionality and available subcommands. * fix: add missing newline for better readability in Aspire 13.2 release notes * fix: update breaking changes section with accurate anchor link in Aspire 13.2 release notes * Add aspire wait CLI command documentation (#452) Add reference documentation for the new 'aspire wait' command that blocks until a named resource reaches a target status (healthy, up, or down) with a configurable timeout. This enables CI/CD and automation workflows where callers need to wait for resources to be ready after 'aspire run --detach'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: update CODEOWNERS for workflow files and add translations for Support in sidebar feat: correct baseUrl in astro.config.mjs fix: update download counts and versions in aspire-integrations.json fix: update GitHub stars in github-stats.json * Update postgres mcp diagnostics page (#453) Fixes #216 * chore: remove outdated documentation migration and coverage audit plans * Add MCP security, troubleshooting, and deployment documentation (#457) * Initial plan * Add security, troubleshooting, and deployment docs to MCP configuration page Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * chore: update package manager version and improve code formatting in OsAwareTabs component * feat: add floating icons to HeroSection and TopicHero components; update documentation pages with relevant icons * feat: implement dynamic positioning for floating icons in HeroSection and TopicHero components * feat: disable telemetry during CI/CD documentation testing and update Aspire 13.2 release notes * feat: update mcp configuration, add playwright-cli support, and enhance documentation * feat: add MongoDB integration support with EF Core, including documentation and sidebar updates - closes #419 (work around merge conflicts) * Refactor documentation frontmatter to remove unnecessary 'prev' and 'next' fields across multiple integration pages; implement custom route middleware for pagination rules in the documentation sidebar. * chore: update screenshots (add support for theme-awareness.) * chore: Update images and add support for theme aware. * chore: add a thank you page * chore: add a few more OSS projects to highlight. * fix: remove duplicate frontmatter entry * feat: add guidelines for using Kbd and LearnMore components in documentation * feat: enhance documentation for aspire commands with interactive terminal notes and output format updates * feat: update link formatting in community thanks documentation to use icons * feat: remove outdated integration documentation and add release verifier agent * feat: update sidebar link styles to use color-mix for improved accessibility * Add missing ASPIREMCP001 and ASPIREATS001 diagnostics, fix ASPIREINTERACTION001 duplicate and corruption (#473) * Initial plan * Add missing ASPIREMCP001 and ASPIREATS001 diagnostic pages, fix duplicate ASPIREINTERACTION001 in overview, fix corrupted aspireinteraction001.mdx Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * feat: enhance integrations component with search and filter options, update localization for new features * Add Azure Container Registry WithPurgeTask documentation. (#474) See https://github.com/dotnet/aspire/pull/14683 * Add samples catalog: skill, data pipeline, and browsable samples page (#479) * chore: Add samples data and update SKILL based on aspire-samples repo. * feat: add SampleCard and SampleGrid components for displaying sample projects - Implemented SampleCard component to render individual sample details including title, description, tags, and thumbnail. - Created SampleGrid component to manage and display a grid of SampleCard components, including search and filter functionality. - Added a new documentation page for samples, integrating SampleGrid to showcase available sample projects. * feat: refactor tag label handling into a shared utility module * feat: enhance tag handling and improve error management in sample updates * docs: update LearnMore links for clarity in polyglot and C# file-based app documentation * docs: improve formatting and clarity in C# file-based apps documentation * docs: update AI integrations section with GitHub and OpenAI models * docs: refine hover effects and active states for Expand component * chore: update package references, removing unused bits. * fix: update documentation links for integrations to include 'get-started' paths * chore: Minor style updates. * fix: update integration count and correct azure storage command in documentation * fix: improve formatting and clarity in Aspire 13.2 documentation * fix: update color styles for improved accessibility in CapabilityGrid and FeatureShowcase components * fix: update @catppuccin/starlight dependency to version 1.1.1 * fix: correct formatting of code blocks in Aspire 13.2 installation instructions * Update Azure SQL Server docs for private endpoints (#487) * Initial plan * Add Azure SQL Server admin deployment script docs for private endpoints Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> * PR feedback * change to caution * Move the docs down --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com> * feat: add PageTitle component and improve floating icon formatting in documentation * feat: add StreamCard component for embedding video streams * fix: update Redis documentation to improve formatting and clarity * CLI: Add `aspire otel` command reference docs (#503) * Initial plan * Add aspire otel CLI command documentation (logs, spans, traces) Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * CLI docs: aspire setup → doctor, option standardization for 13.2 (#504) * Initial plan * Update CLI docs for aspire setup → doctor change and CLI option standardization - Update aspire-doctor.mdx: Add note about aspire setup being hidden, fix --json → --format option to match actual CLI - Update option-version.md: Add -v short alias for --version - Update aspire-13-2.mdx: Add note about setup being hidden in doctor section, add CLI option standardization subsection Fixes #463 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Document DefaultAzureCredential breaking change in client integrations (#517) * Initial plan * Document DefaultAzureCredential breaking change in client integrations - Add new common doc page explaining default credential behavior - Add breaking change section in Aspire 13.2 what's new - Update all client integration docs to link to new credential doc Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> * Add AZURE_TOKEN_CREDENTIALS env var explanation to default credential doc Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> * Add deterministic credentials best practices link to credential behavior section Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> * Simplify breaking change section in aspire-13-2.mdx to avoid duplicating credential doc Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> * Add diagnostics doc for ASPIREAZURE003 (#525) * Initial plan * Add diagnostics doc for ASPIREAZURE003 (Azure Virtual Networks) Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> * Update builder resource addition to use await (#532) * Update builder resource addition to use await * Update polyglot-apphost.mdx --------- Co-authored-by: David Pine <david.pine@microsoft.com> * Revamp VS Code extension doc and add cross-references (#538) - Rewrote aspire-vscode-extension.mdx with clearer structure: features overview, prerequisites, getting started, running/debugging, sidebar, commands, language support, settings, MCP, and feedback sections - Consolidated commands into a single flat table with all 16 commands - Added launch config examples for deploy, publish, pipeline steps, and per-language debugger customization - Fixed wrong marketplace link in python.mdx (ms-dotnettools.dotnet-aspire → docs page link) - Added extension cross-references to install-cli, first-app, add-aspire-existing-app, and dev-containers pages * feat: build out infrastructure to generate API docs (#522) * feat: build out infrastructure to generate API docs for both C# and TypeScript * fix: address copilot PR review suggestions for API docs components (#523) * Initial plan * fix: address PR review suggestions from copilot reviewer Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Refactor code structure for improved readability and maintainability * fix: refine sidebar collapse behavior for API reference pages * fix: update search component styles for better visibility on API reference pages * fix: update API reference links to point to C# APIs * feat(api): add support for standalone functions in TypeScript API reference - Implemented functionality to generate static paths for standalone functions without a qualified name. - Enhanced the TypeScript API reference pages to display function signatures, parameters, and return types. - Updated the sidebar to include functions alongside types and enums. - Improved the presentation of function details, including links back to parent types and method definitions. - Refactored existing code for better clarity and consistency in naming conventions (e.g., changed "Enumerations" to "Enums"). - Introduced a new InpageSearchSync component for managing search state in the URL. - Added a new method detail page for displaying individual method capabilities of handle types. * feat(api-reference): add unified search bar and version filter components - Introduced `ApiSearchBar` component for a unified search interface with kind filters and version dropdown. - Added `VersionFilter` component for version selection with checkbox toggles and "Select all" functionality. - Updated CSS styles for new components and adjusted existing styles for consistency. - Modified API sidebar links to include a specific path for C# references. - Enhanced page title styling for better visibility. * fix(api-reference): improve layout and overflow handling for breadcrumb and member card components * feat(breadcrumbs): implement content breadcrumbs functionality and integrate with Markdown content * feat(api-reference): add API reference path to the configuration * feat(banner): add announcement banner component with dismiss functionality * feat(thanks): add LicenseBadge component and license titles data * fix(deployment): update prerequisites for Azure deployment documentation * feat(terminal-showcase): enhance terminal showcase styling and add gradient effect feat(page-title): refactor page title component to use PageActionsPageTitle fix(api-pages): disable page actions for API reference pages style(css): remove unnecessary dropdown menu styling * refactor(PageTitle): simplify dropdown handling and improve API page title initialization * fix(api-reference): improve overflow handling for code, links, and preformatted text * feat(Search): add API search notice with links to C# and TypeScript references --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add Virtual Network support to What's New (#541) * fix: correct import statement and update documentation formatting in polyglot-apphost * docs: update Aspire 13.2 release notes with new features and breaking changes * feat: add Dependabot configuration for npm package updates * feat: add script import for inpage search synchronization * fix: update license URLs for Redis and Docker in thanks-license-titles.ts * feature: Add TS/JS first app/deploy bits * feat: enhance documentation for Polyglot AppHost migration and troubleshooting * Replace polyglot AppHost with TypeScript AppHost, fork getting started paths (#556) * Replace polyglot AppHost with TypeScript AppHost, fork getting started paths - Rename polyglot-apphost/migration/troubleshooting docs to typescript-apphost-* - Add redirects from old polyglot URLs to new typescript-apphost URLs - Fork prerequisites page with C# AppHost / TypeScript AppHost pivot - TypeScript path: Node.js + Docker + VS Code (no .NET required) - C# path: .NET SDK + Docker + VS Code/VS/Rider - Add TypeScript AppHost code example to 'What is Aspire' page - Add TypeScript AppHost structure tab to AppHost explainer page - Add TypeScript variant to SimpleAppHostCode component - Remove .NET SDK requirement from CLI install page - Replace 'polyglot' with 'multi-language' across all docs - Remove polyglotSupportEnabled from config examples (on by default) - Update sidebar: Polyglot -> TypeScript AppHost - Update all cross-references and link text site-wide - Add (Preview) to TypeScript AppHost page titles Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove accidentally committed screenshots Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix config settings table and CLI command references - Remove stale config flags from settings table and JSON example: dotnetSdkInstallationEnabled, minimumSdkCheckEnabled, orphanDetectionWithTimestampEnabled, packageSearchDiskCachingEnabled, runningInstanceDetectionEnabled, stagingChannelEnabled, polyglotSupportEnabled - Fix aspire run --debug (doesn't exist) to aspire run --log-level Debug Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Simplify pivot labels to C#/TypeScript, remove .NET aside Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Move C# extension recommendation into C# pivot only The VS Code C# extension was showing for both C# and TypeScript paths on the prerequisites page. Now only shown for C#. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix C#-first framing on What is Aspire page Change 'type-safe C#' to 'type-safe code' since the section now shows both C# and TypeScript AppHost examples. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add C#/TypeScript language toggle to landing page AppHostBuilder Add a language switcher to the interactive AppHost code builder on the landing page. TypeScript variants use Express for the API service (addNodeApp) while C# uses AddProject, matching each ecosystem's natural patterns. All 31 toggle combinations work in both languages. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address PR review: fix TS AppHost file tree, restore polyglot SEO keyword - Remove .aspire/settings.json from TypeScript AppHost file tree (only aspire.config.json is needed) - Add polyglot back as an SEO keyword alongside multi-language to preserve search ranking Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add multi-language integrations guide (#558) * Add multi-language integration authoring guide New doc explaining how integration authors export their APIs for TypeScript AppHosts using [AspireExport], [AspireDto], [AspireExportIgnore], and [AspireUnion] attributes. Covers the analyzer (ASPIREEXPORT001-010), local development with project references in aspire.config.json, third-party attribute definitions, and a supported types reference. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Shorten sidebar label to 'Integration exports' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rename title to 'Multi-language integrations' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove 'non-.NET' phrasing from integration authoring doc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: David Pine <david.pine@microsoft.com> * Refactor code formatting and improve TypeScript SDK example in multi-language integration authoring guide * Address PR review feedback - Don't hardcode diagnostic count, describe scenarios generically - Show NoWarn in csproj instead of #pragma for ASPIREATS001 - Add ExposeProperties/ExposeMethods examples (per sebastienros) - Fix supported types: delegates, ILogger, IServiceProvider are compatible - Remove Third-party integrations section (implementation detail per davidfowl) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add cross-links from TypeScript AppHost articles to multi-language integrations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * Add ASPIREEXPORT001-010 diagnostics articles for Polyglot support (#564) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * feat: enhance API search functionality with in-page search synchronization * feat: add SurrealDB integration documentation * fix: update links in community documentation and enhance upgrade section in release notes * Restructure AI coding agents docs: skill-first, MCP as sub-pages (#561) * Reframe AI coding agents page: skill-first, MCP as subsection - Rename page from 'Configure the MCP server' to 'AI coding agents' - Lead with aspire agent init and the Aspire skill file - Add AGENTS.md migration section (skill file replaces it) - Move MCP server details to a linked sub-page (to be created) - Add AI/MCP/agent SEO keywords to site metadata - Update sidebar label and cross-references Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add Aspire MCP server sub-page Move MCP tools reference, security model, troubleshooting, and deployment considerations to a dedicated page under the AI coding agents section. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add Resource MCP servers page New page covering WithMcpServer(), WithPostgresMcp(), aspire mcp tools, and aspire mcp call for resources that expose their own MCP endpoints. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Nest MCP pages under AI coding agents sidebar group Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add TypeScript tabs to all AppHost samples, add missing MCP tools - Add C#/TypeScript tabs to all 4 AppHost code blocks across aspire-mcp-server.mdx and resource-mcp-servers.mdx - Add 5 missing MCP tools to the tools table: list_docs, search_docs, get_doc, doctor, refresh_tools Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add 'Why Aspire for coding agents' section to overview Explain the CLI's agent-friendly design: background start, wait, structured output, non-interactive mode, docs search, and how the skill file teaches agents these patterns. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix MCP server description — same data as CLI and dashboard Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Reframe MCP server — same visibility for humans and agents Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Lead 'Why Aspire' with runtime visibility, commands as supporting detail Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rename 'Connection problems' to 'If your agent can't connect' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Move MCP config JSON tabs from overview to MCP server page The AI coding agents overview now just links to the MCP server page for configuration details. The per-environment JSON examples live on the dedicated page where they belong. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rename configure-mcp to ai-coding-agents, add redirect Rename the file to match its content. Update all 11 cross-references across the site. Add redirect from old URL. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: David Pine <david.pine@microsoft.com> * Apply suggestions from code review Co-authored-by: Maddy Montaquila (Leger) <maddyleger1@gmail.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> Co-authored-by: Maddy Montaquila (Leger) <maddyleger1@gmail.com> * Refresh CLI recordings for 13.2 (#565) * Refresh Aspire CLI recordings for 13.2 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat: update Asciinema recordings and enhance documentation for CLI commands * Refine CLI recording playback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Swap CLI overview to banner cast Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Split banner and help recordings Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add multi-language architecture page, remove redundant TypeScript AppHost docs (#563) - Delete typescript-apphost.mdx (first-app JS pivot covers this) - Delete typescript-apphost-troubleshooting.mdx (empty stub) - Delete typescript-apphost-migration.mdx (not needed yet) - Remove TypeScript AppHost sidebar group - Add multi-language architecture page under Architecture covering guest/host model, ATS type system, SDK generation, polymorphism flattening, startup sequence, token-based auth - Move TS troubleshooting to general troubleshooting page - Update all cross-references and redirects Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update documentation to reflect changes in AI coding agent configuration - Replaced references to "Configure MCP" with "AI coding agents" in multiple documentation files to align with new setup instructions. - Removed the "Configure MCP" documentation file and created new files for "Use AI coding agents" and "Aspire MCP server" to provide clearer guidance on setting up AI coding agents and their interaction with the MCP server. - Added a new section on exposing MCP servers from Aspire resources, detailing how to interact with them using the CLI. - Updated various sections to improve clarity and ensure consistency across documentation regarding AI agent environments and MCP server usage. * Revert "Update documentation to reflect changes in AI coding agent configuration" This reverts commit 8ed461c8e0d15d87cc5cac28afbb783136a0a60a. * Revert "Add multi-language architecture page, remove redundant TypeScript AppHost docs (#563)" This reverts commit 30910eb53c25727b4ef366c92017d2a2e6857443. * Add aspire secret CLI command documentation (#549) * Initial plan * Add aspire secret CLI command documentation pages and sidebar entries Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Refactor documentation and remove TypeScript AppHost references; add multi-language architecture guide * Remove Japanese "Configure MCP Server" documentation * Remove obsolete aspire mcp command reference from documentation * Update code display div to include 'not-content' class for better styling * Revise 'What is Aspire?' documentation for clarity and detail on features and benefits * Enhance SimpleAppHostCode component with TypeScript support and improve documentation examples for various languages * feat: Enhance "What is Aspire?" documentation with detailed explanations and examples - Updated the description to clarify Aspire's code-first and agent-enabled workflow. - Added sections on the challenges of distributed development without Aspire. - Included a comparison table highlighting the benefits of using Aspire. - Provided step-by-step commands for starting services with and without Aspire. - Introduced code snippets for C# and TypeScript AppHost configurations. - Emphasized the advantages of a unified model for both development and production environments. - Added tips for using AI coding agents and handling multi-language stacks. * Update banners and Aspire Conf page for Live broadcast (#569) * Update 13.2 API ingestion and API reference UX (#571) * refactor: Simplify integration filtering logic in gallery component * Remove .NET-isms from AppHost docs, add C#/TypeScript tabs (#568) * Move Aspire SDK and templates from Get Started to AppHost > C# AppHost These pages are 100% .NET-specific (NuGet packages, .csproj files, dotnet new templates) but had generic labels in the universal Setup and tooling section. Now scoped under AppHost > C# AppHost where the context is clear. Fixes #566 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add TypeScript AppHost project structure page Document aspire.config.json, .modules/ directory, apphost.ts, and package.json for TypeScript AppHost projects. Adds a balanced TypeScript AppHost group alongside the C# AppHost group in sidebar. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Shorten sidebar labels: C# AppHost → C#, TypeScript AppHost → TypeScript Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Consolidate into 'Language support' group under AppHost Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * POC: Language toggles on AppHost pages, Project structure sidebar - Sidebar: 'Project structure' group with C# and TypeScript sub-pages - Configuration page: C#/TypeScript tabs for launch profile config (launchSettings.json vs aspire.config.json) - Eventing page: C#/TypeScript tabs for event subscription examples Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add C#/TypeScript tabs to all AppHost code samples Add language toggles to every AppHost code block across 7 pages: persistent-containers, withdockerfile, executable-resources, certificate-configuration, container-files, migrate-from-docker-compose. Mark dotnet-tool-resources as C# AppHost only. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove .NET-specific language from AppHost page descriptions - docker-compose reference: 'C# API calls' → 'AppHost API calls' - executable-resources: remove ExecutableResource class name from description - withdockerfile: remove .csproj reference from context path description Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Move .NET tool resources to Integrations → Frameworks & runtimes It's a .NET-specific integration, not a generic AppHost resource type. Renamed sidebar label to '.NET CLI tools' for clarity. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix TypeScript API bugs found by tsc compilation Validated all TS code samples against generated SDK: - withLifetime: use ContainerLifetime.Persistent enum, not string - addExecutable: args param is string[], not string - addContainer: 2 args (tag in image string), not 3 Test project at /tmp/ts-api-validation/ compiles clean. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix remaining TS API issues found by tsc validation - addProject: add required 3rd arg (launch profile 'https') across 4 files - withContainerFiles: mark as not yet available in TS SDK - All TS code samples now compile clean against generated SDK Test project at /tmp/ts-api-validation/ validates all APIs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix app.host.ts → apphost.ts in all TypeScript code block titles 46 occurrences across 6 files. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add `aspire describe` CLI command documentation (#502) * Initial plan * Add aspire describe command documentation (renamed from aspire resources) Addresses #461: CLI aspire resources renamed to aspire describe with --watch renamed to --follow/-f. Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix alphabetical ordering of aspire describe in sidebar Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Address review feedback: wrap Steps, expand NDJSON, add what's new entry - Wrap numbered list in Steps component per review feedback - Expand NDJSON acronym to Newline Delimited JSON with links - Add 'Resource monitoring with aspire describe' section to what's new 13.2 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add case-insensitive note to --format option Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Replace ndjson.org links with GitHub spec repo Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update Foundry integration naming: Aspire.Hosting.Azure.AIFoundry → Aspire.Hosting.Foundry (#518) * Update Foundry integration naming: Azure AI Foundry → Microsoft Foundry - Rename package references from Aspire.Hosting.Azure.AIFoundry to Aspire.Hosting.Foundry - Update type references: AzureAIFoundryResource → FoundryResource - Update method references: AddAzureAIFoundry → AddFoundry - Update branding from 'Azure AI Foundry' to 'Microsoft Foundry' in all docs - Keep 'Foundry Local' naming unchanged - Update integration data files (names, docs links, integrations catalog) - Update sidebar, integration grid, compatibility matrix - Update whats-new release notes for 9.4 and 9.5 Related: dotnet/aspire#14149 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * Revert changes in whatsnew * Update articles with AddProject * Use enumerations for models * Add note about new name --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * docs: Enhance documentation for contextual endpoint resolution in Aspire 13.2 * Update source repository references from dotnet/aspire to microsoft/aspire across multiple files and scripts. This includes JSON module files, helper functions, and documentation updates to reflect the new repository URL. Additionally, adjustments were made in the code to normalize source repository URLs and ensure consistency in tests and command descriptions. * refactor: Enhance string formatting in Write-TestSummary.ps1 for better readability * fix: Update links in documentation for Aspire 13.2 release and improve formatting * Add new JSON module for Aspire.Hosting.Maui and implement stable file writing helper - Created a new JSON module for Aspire.Hosting.Maui version 13.2.0-preview.1.26170.3, defining various methods for managing Android and iOS devices, emulators, and project resources. - Implemented `StableFileWriter` helper class in both AtsJsonGenerator and PackageJsonGenerator to handle writing files only if content has changed, ensuring consistent line endings and UTF-8 encoding without BOM. * feat(cli): update configuration management and command options - Introduced project-scoped configuration with `aspire.config.json`, replacing the legacy `.aspire/settings.json`. - Enhanced the configuration settings table to reflect new settings and their descriptions. - Removed the deprecated `--debug` option and added new commands for managing HTTPS certificates (`aspire certs`, `aspire certs clean`, `aspire certs trust`). - Added commands for exporting telemetry and logs (`aspire export`, `aspire logs`). - Introduced MCP command functionality with `aspire mcp`, `aspire mcp call`, and `aspire mcp tools`. - Added `aspire resource` command for executing resource-specific commands. - Updated CLI command descriptions and examples for clarity and consistency. - Added new options for banner display, log level configuration, and suppression of the startup logo. * fix(docs): update references to Aspire templates in release notes for clarity * Remove tool generator tests from release/13.2 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(docs): remove redundant references to breaking changes in Aspire 9.2 documentation * Fix security alerts * Refactor code structure for improved readability and maintainability * Follow up #568 with .NET docs reorganization (#579) * Follow up 568 with .NET docs reorganization Restore the broader .NET docs IA that #568 described but that did not land in the merged diff. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove .NET-specific details from networking overview Move the remaining launch-profile, project-resource, and .NET-specific inner-loop networking details behind links to the dedicated .NET docs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Reframe getting started docs around AppHost language (#580) * Reframe existing app guide for JS and TS AppHosts Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Group getting started docs by AppHost language Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Refine AppHost language getting started copy Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Refactor documentation for clarity and consistency across AppHost guides --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> * fix(docs): update links to "Build your first app" for TypeScript AppHost across multiple documents * fix(docs): update links to ServiceDefaults in C# AppHost documentation * Fix certificate docs: validate TS samples, use aspire certs, remove .NET-isms (#582) * Fix certificate docs: validate TS samples, use aspire certs, remove .NET-isms - Replace dotnet dev-certs with aspire certs trust/clean - Fix TS samples: withDeveloperCertificateTrust takes boolean not object, withCertificateTrustScope takes CertificateTrustScope enum not string, withHttpsDeveloperCertificate takes options object, addNpmApp -> addNodeApp - Remove TS samples for APIs not yet in TS SDK (withHttpsCertificate, withHttpsCertificateConfiguration, addCertificateAuthorityCollection, withCertificateTrustConfiguration, withContainerCertificatePaths) - Add consistent 'not yet available in TypeScript AppHosts' notes - Replace 'ASP.NET Core development certificate' with 'development certificate' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Replace dotnet user-secrets with aspire secret set across docs - persist-data-volumes.mdx: SQL password parameter - secure-communication.mdx: MailDev username/password - openai-get-started.mdx: OpenAI API key - openai-host.mdx: OpenAI API key - local-provisioning.mdx: Azure subscription/location Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Replace dotnet dev-certs with aspire certs trust in SDK templates doc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add link validation rules to doc-tester skill - Require site-relative paths with trailing slashes - Check for valid targets and anchors - Add link checks to focus area templates Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update dashboard configuration docs to match C# source code (#585) * Maddy/13.2 whats new (#584) * commit so i can grab latest 13.2 changes * Tons of moves * fixed ts slop * Dashboard section improvements * Fix broken links and malformed install code blocks in Aspire 13.2 What's New doc (#586) * Initial plan * Fix broken links and malformed install code blocks found by doc-tester Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/aspire.dev/sessions/7eb3b1a7-0a30-436f-a036-7527613664f1 --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Address PR #584 review feedback - Delete aspire.config.json upgrade tab (first release, nothing to update from) - Reword CLI intro to emphasize exposing data from dashboard/apphost via CLI - Remove 'Aspire SDK installation and version' from doctor checks (not yet implemented) - Delete 'Non-interactive mode' section (not working yet) - Delete 'Integration scaffolding with aspire template' section (doesn't exist) - Apply JamesNK suggestions (JSON output, emoji alignment, data export title) Image feedback (dark theme variants, red highlight outlines) noted but requires manual image creation — not addressed in this commit. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix fabricated and broken code samples in 13.2 what's-new - Remove DurableTaskScheduler section (PR #13711 not merged, no package) - Remove Foundry TS sample (publishAsHostedAgent is AspireExportIgnore'd) - Remove WithVolume on ProjectResource section (container-only API) - Fix withMcpServer: takes options object, not string - Fix Docker Compose: remove WithComposeFile (doesn't exist), fix description to 'publishing' not 'import' - All remaining TS samples validated with tsc --noEmit against actual SDK Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add validated Foundry TypeScript sample using local project reference Validated addFoundry, addProject, addModelDeploymentFromModel, and publishAsHostedAgent against actual TS SDK generated from local Aspire.Hosting.Foundry csproj. All compile clean. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Note Foundry TypeScript support is in preview Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Mark TypeScript AppHost support as preview Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Remove aspire new --template (not in CLI yet) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Show aspire start --isolated alongside aspire run --isolated Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: James Newton-King <james@newtonking.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Fowler <davidfowl@gmail.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix aspire-samples links from microsoft to dotnet org (#589) * Add OTLP/HTTP endpoint mapping to standalone dashboard docs (#588) * Add OTLP/HTTP endpoint mapping to standalone dashboard docs * Update * CLI overview: add new command sections and mark otel as Preview (#587) * Updates for Agent-ready messaging for 13.2 release (#535) Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com> * Revert "Updates for Agent-ready messaging for 13.2 release (#535)" (#591) This reverts commit 813b77e0137d68c1c5e09fd85fa9f06dcfced9c5. --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: Sébastien Ros <sebastienros@gmail.com> Co-authored-by: James Newton-King <james@newtonking.com> Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com> Co-authored-by: Tristan <Tri125@users.noreply.github.com> Co-authored-by: Mitch Denny <midenn@microsoft.com> Co-authored-by: Mitch Denny <mitch@mitchdeny.com> Co-authored-by: mitchdenny <513398+mitchdenny@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Maddy Montaquila (Leger) <maleger@microsoft.com> Co-authored-by: Jose Perez Rodriguez <joperezr@microsoft.com> Co-authored-by: Alex Crome <afscrome@users.noreply.github.com> Co-authored-by: Alex Ravenna <alex.n.ravenna@gmail.com> Co-authored-by: David Bottiau <bottiau.david@laposte.net> Co-authored-by: Beth Massi <bethma@microsoft.com> Co-authored-by: eerhardt <8291187+eerhardt@users.noreply.github.com> Co-authored-by: Adam Ratzman <adam@adamratzman.com> Co-authored-by: David Fowler <davidfowl@gmail.com> Co-authored-by: Maddy Montaquila (Leger) <maddyleger1@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
New documentation for integration authors explaining how to make their Aspire hosting integrations work with TypeScript AppHosts and other non-.NET app hosts.
Relates to dotnet/aspire#14069 (Part 4: Extensibility for Integration Authors)
Changes
extensibility/multi-language-integration-authoring.mdxcovering:[AspireExport]on extension methods and resource types[AspireDto]for configuration objects[AspireExportIgnore]for incompatible overloads[AspireUnion]for multi-type parametersAspire.Hosting.Integration.Analyzers) with all 10 diagnostic rules (ASPIREEXPORT001–010)aspire.config.json(from Add project reference support for polyglot apphost integrations aspire#14821)Testing
[AspireExport], referenced it via.csprojpath in a TypeScript AppHost, confirmed SDK generation and resource startup (test project at/tmp/aspire-projref-e2e/)