Skip to content

[docs] Clarify EnableOnDemandResources and EmbedOnDemandResources properties - #26310

Merged
rolfbjarne merged 2 commits into
mainfrom
dev/rolf/issue-26218-ios-odr-not-working-27b1ac
Jul 28, 2026
Merged

[docs] Clarify EnableOnDemandResources and EmbedOnDemandResources properties#26310
rolfbjarne merged 2 commits into
mainfrom
dev/rolf/issue-26218-ios-odr-not-working-27b1ac

Conversation

@rolfbjarne

Copy link
Copy Markdown
Member

Expand the documentation for the two on-demand-resources (ODR) build
properties. The difference between them caused customer confusion in
issue #26218, where a user thought on-demand resources were disabled by
default (they aren't on iOS) and that the "Embed on-demand resources in the
app bundle" option was what turned the feature on (it doesn't).

  • EnableOnDemandResources: explain that this is what turns ODR on, and show
    how to tag a resource with ResourceTags metadata — using Update rather
    than Include for resources that are already part of the project's default
    resources, and mentioning the MauiAsset equivalent for .NET MAUI projects.
  • EmbedOnDemandResources: clarify that it does NOT enable ODR, and only
    controls where asset packs are placed when packaging an IPA for
    distribution.

The two entries now cross-reference each other.

This is a documentation-only change; it does not change any build behavior and
does not by itself fix #26218 (which was a user project-metadata problem).

🤖 Pull request created by Copilot

…perties

Expand the documentation for the two on-demand-resources (ODR) build
properties, since the difference between them caused customer confusion in
issue #26218:

* EnableOnDemandResources: explain that it's what turns ODR on, and show how
  to tag a resource with ResourceTags metadata (using Update rather than
  Include for already-globbed resources, and mentioning the MauiAsset
  equivalent).
* EmbedOnDemandResources: clarify that it does NOT enable ODR, and only
  controls where asset packs are placed when packaging an IPA for
  distribution.

The two entries now cross-reference each other.
@rolfbjarne
rolfbjarne marked this pull request as ready for review July 27, 2026 17:06
Copilot AI review requested due to automatic review settings July 27, 2026 17:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Clarifies the documentation for iOS/macOS on-demand resources (ODR) MSBuild properties to reduce user confusion, particularly around which property enables ODR vs how ODR asset packs are packaged for distribution.

Changes:

  • Expanded EmbedOnDemandResources docs to explain it affects packaging layout, not whether ODR is enabled.
  • Expanded EnableOnDemandResources docs with an example showing how to tag resources using ResourceTags metadata (and guidance on Update vs Include).
  • Added cross-references between the two properties.

Comment thread docs/building-apps/build-properties.md
@rolfbjarne rolfbjarne added the ready-to-review This PR is ready to review/merge. label Jul 27, 2026
dalexsoto
dalexsoto previously approved these changes Jul 27, 2026
Address PR review feedback: for AppStore distribution the asset packs are
always placed outside the .app bundle regardless of EmbedOnDemandResources;
the property only changes the packaging layout for AdHoc distribution.
@rolfbjarne
rolfbjarne merged commit 3cbf3d4 into main Jul 28, 2026
11 checks passed
@rolfbjarne
rolfbjarne deleted the dev/rolf/issue-26218-ios-odr-not-working-27b1ac branch July 28, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

copilot ready-to-review This PR is ready to review/merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

iOS ODR not working

3 participants