docs: Add App Model API documentation for CORS, console apps, resource naming, and networking - #454
docs: Add App Model API documentation for CORS, console apps, resource naming, and networking#454David Pine (IEvangelist) with Copilot wants to merge 1 commit into
Conversation
David Pine (IEvangelist)
left a comment
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
This PR looks good so far, but let's double check it for accuracy by using the .github/skills/doc-tester/SKILL.md skill. Please also consider all new comments and feedback. Copilot
Ran the doc-tester validation on all new and updated pages. Here's what was verified: All internal links return HTTP 200 — Content accuracy checks:
One structural fix made (commit e1a909e): An Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
David Pine (IEvangelist)
left a comment
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
This PR looks good so far, but let's double check it for accuracy by using the .github/skills/doc-tester/SKILL.md skill. Please also consider all new comments and feedback/suggestions. Copilot
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Pull request overview
Adds new AppHost documentation pages to close gaps around CORS, console/worker apps, and resource naming, and extends the networking fundamentals page with LAN binding and container-to-host guidance.
Changes:
- Added new AppHost docs: CORS configuration, console/worker apps, and resource naming conventions.
- Expanded
networking-overview.mdxwith LAN binding and container-to-host networking sections. - Updated the docs sidebar and refreshed the integrations catalog metadata.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/data/aspire-integrations.json | Updates integration package versions/icons/download counts; adds new CommunityToolkit entries. |
| src/frontend/src/content/docs/fundamentals/networking-overview.mdx | Adds LAN binding guidance and container-to-host networking + KnownNetworkIdentifiers examples. |
| src/frontend/src/content/docs/app-host/resource-naming.mdx | New page describing env var mapping, dash→underscore behavior, and naming guidance. |
| src/frontend/src/content/docs/app-host/cors-configuration.mdx | New page explaining when/how to configure CORS (dev/prod patterns + common issues). |
| src/frontend/src/content/docs/app-host/console-apps.mdx | New page documenting console/worker app orchestration, service discovery, and dashboard logs. |
| src/frontend/config/sidebar/docs.topics.ts | Adds new AppHost pages to the sidebar. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
David Pine (IEvangelist)
left a comment
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
This PR looks good so far, but let's double check it for accuracy by using the .github/skills/doc-tester/SKILL.md skill. Please also consider all new comments and feedback/suggestions. Copilot
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
|
Still planning to merge? |
![aspire-repo-bot[bot]](https://avatars.githubusercontent.com/in/3085065?s=60&v=4){kind=small}
David Pine (IEvangelist)
added
the
ci:skip-forbidden-words
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
David Pine (IEvangelist)
removed
the
ci:skip-forbidden-words
ffdbece to
16278f4
Compare
Addresses gaps identified from 20K+ Discord community messages where users had no documentation for several common AppHost scenarios.
New pages
app-host/resource-naming.mdx— How resource names map to env vars (ConnectionStrings__<name>,services__<name>__<endpoint>__0), the dash→underscore transformation (my-service→ConnectionStrings__my_service), naming best practices (dashes preferred, underscores valid), and resource name validation rules (links to ASPIRE006 diagnostic).app-host/console-apps.mdx— Adding .NET console/worker projects to AppHost viaAddProject, plus links toAddExecutable,AddPythonApp, andAddNodeAppfor non-.NET apps. Covers wiring service discovery on non-ASP.NET Core hosts,BackgroundServicepatterns,WithExplicitStart()for interactive apps, and dashboard console output.app-host/cors-configuration.mdx— When CORS is (and isn't) needed with Aspire, ASP.NET Core Minimal API middleware setup withAddCors/UseCors, environment-based origins, usingWithReference(frontend)to auto-inject the frontend URL into API CORS config, common failure patterns (middleware ordering, preflight, credentials), and dashboard CORS env var.Updated pages
fundamentals/networking-overview.mdx— Two new sections:WithHttpEndpointmaps ports only; the app must also bind viaWithEnvironment), and executablesWithReferencefor automatic cross-platform host resolution,AddConnectionStringfor existing host services, andKnownNetworkIdentifiersSidebar
Added all three new pages under the AppHost section in
docs.topics.tswith Japanese (ja) translations.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.