Skip to content

Conversation

@davidfowl
Copy link
Member

Added the app model guide to the repo. This is great for LLMs to consume.

@Copilot Copilot AI review requested due to automatic review settings July 12, 2025 19:23
@github-actions github-actions bot added the area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication label Jul 12, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds a comprehensive application model guide to the Aspire documentation, covering concepts, design patterns, and authoring guidance.

  • Introduces a Quick Start section with sample code and a Mermaid diagram.
  • Provides in-depth explanations of resources, built-in types, interfaces, API patterns, and full examples (Redis, Talking Clock).
  • Includes a glossary and reference tables for annotations, events, and value types.
Comments suppressed due to low confidence (4)

docs/specs/appmodel.md:648

  • [nitpick] Use 'csharp' for code fences instead of 'C#' to match other examples and standard Markdown conventions.
```C#

docs/specs/appmodel.md:784

  • [nitpick] This heading is level 2 inside a subsection; consider using '###' to maintain the nested section hierarchy under 'Referencing Endpoints from Other Resources'.
## EndpointReferenceExpression – accessing endpoint parts

docs/specs/appmodel.md:126

  • [nitpick] Resource names differ from the Quick Start section (here using 'backend' vs. 'api'). Consider aligning names across examples for consistency.
var api = builder.AddProject("backend").WithReference(pg);

docs/specs/appmodel.md:1

  • [nitpick] This document exceeds 1500 lines; consider splitting into smaller, focused files or sections to improve maintainability and navigation.
# Aspire Resource Model: Concepts, Design, and Authoring Guidance

@davidfowl davidfowl enabled auto-merge (squash) July 12, 2025 19:44
@davidfowl davidfowl merged commit 41e568b into main Jul 12, 2025
273 of 274 checks passed
@davidfowl davidfowl deleted the davidfowl/appmodel-guide.md branch July 12, 2025 19:56
@github-actions github-actions bot locked and limited conversation to collaborators Aug 12, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants