Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

This repository contains the conceptual documentation for .NET Multi-platform App UI (MAUI). It's published at the [.NET MAUI documentation site](https://learn.microsoft.com/dotnet/maui).

## LLMS Files

This repo includes curated `llms.txt` files for AI-friendly documentation discovery.

- Use [docs/llms.txt](docs/llms.txt) for top-level routing across the MAUI docs set.
- Use subtopic `llms.txt` files when the question is scoped to one area such as fundamentals, user interface, platform integration, data, or deployment.
- Use nested `llms.txt` files for higher-signal retrieval in busy areas such as data binding, Shell, controls, handlers, and CollectionView.
- Use [docs/llms-full.txt](docs/llms-full.txt) only when a tool needs one broader context file and cannot follow subtopic links.
- Validate changes with `./docs/tools/verify-llms.ps1`.

## Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
30 changes: 30 additions & 0 deletions docs/data-cloud/llms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# .NET MAUI Data and Cloud

> Data access patterns for MAUI apps, including REST services, local SQLite persistence, local development services, and push notifications.

Use this index for app data flow between local storage and networked services.

Use this file when the question is about API access, local persistence, backend connectivity, or how app state moves between on-device storage and remote systems.

## Guidance for AI assistants

- Prefer HttpClient-based REST patterns and DI-managed services for backend access.
- Use SQLite when the app needs structured local relational storage.
- Separate local development backend setup from production deployment guidance.
- Treat push notifications as platform-aware integration work, not just a generic messaging feature.

## Core data access

- [Consume REST web services](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/data-cloud/rest.md): HttpClient patterns, serialization, and API integration.
- [Local SQLite databases](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/data-cloud/database-sqlite.md): Local relational data storage with SQLite.
- [Local web services](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/data-cloud/local-web-services.md): Configure local API backends for development.

## Cloud and messaging

- [Push notifications](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/data-cloud/push-notifications.md): Notification integration across platforms.
- [Aspire integration](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/data-cloud/aspire-integration.md): Connect MAUI with .NET Aspire-based backends.

## Optional

- [Platform integration overview](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/platform-integration/index.md): Related device and platform APIs often used with data apps.
- [Dependency injection](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/fundamentals/dependency-injection.md): Service registration for repositories and API clients.
39 changes: 39 additions & 0 deletions docs/deployment/llms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# .NET MAUI Deployment and Performance

> Build, publish, trim, and optimize MAUI apps for Android, iOS, Mac Catalyst, and Windows.

Use this index for shipping and performance hardening scenarios.

Use this file when the question is about startup time, app size, trimming, AOT, test strategy, or packaging apps for stores and devices.

## Guidance for AI assistants

- Measure first when diagnosing performance; do not guess.
- Treat compiled bindings, layout simplification, and correct control choice as the first performance levers.
- Recommend trimming and Native AOT only when code and dependencies are compatible.
- Verify publishing guidance against the target platform rather than assuming Android, iOS, and Windows behave the same way.

## Performance and optimization

- [Performance best practices](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/deployment/performance-best-practices.md): Actionable guidance for bindings, layouts, images, startup, threading, and memory.
- [Improve app performance](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/deployment/performance.md): Performance concepts and measurement strategy.
- [Trimming](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/deployment/trimming.md): Reduce app size by removing unused code.
- [Native AOT](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/deployment/nativeaot.md): Ahead-of-time compilation guidance and tradeoffs.

## Build, test, and release

- [Deployment overview](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/deployment/index.md): Cross-platform release flow.
- [Unit testing](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/deployment/unit-testing.md): Testing strategy for MAUI applications.
- [Visual Studio project properties](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/deployment/visual-studio-properties.md): Configure packaging and target settings.

## Platform publishing

- [Android deployment](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/android/deployment/index.md): Build and publish Android artifacts.
- [iOS deployment](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/ios/deployment/index.md): Build and publish for iOS and TestFlight/App Store.
- [Mac Catalyst deployment](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/mac-catalyst/deployment/index.md): Package and publish Mac Catalyst apps.
- [Windows deployment](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/windows/deployment/overview.md): Package and distribute Windows apps.

## Optional

- [Troubleshooting](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/troubleshooting.md): Common issues across build and publish workflows.
- [Supported platforms](https://raw.githubusercontent.com/dotnet/docs-maui/refs/heads/main/docs/supported-platforms.md): Version support constraints that affect shipping decisions.
Loading
Loading