Skip to content

[maui-labs docs] Update platform backend docs: new macOS template, --prerelease flag for all platform templates, macOS API fixes#3314

Draft
github-actions[bot] wants to merge 1 commit intomainfrom
docs-from-code/3311-bc11d578076c825b
Draft

[maui-labs docs] Update platform backend docs: new macOS template, --prerelease flag for all platform templates, macOS API fixes#3314
github-actions[bot] wants to merge 1 commit intomainfrom
docs-from-code/3311-bc11d578076c825b

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 7, 2026

Closes #3311

Source PR

dotnet/maui-labs#251 — feat: Add macOS template, align platform READMEs, fix template packaging

Summary

This PR creates documentation for the experimental .NET MAUI platform backends (macOS AppKit, Linux GTK4, Windows WPF) in a new docs/developer-tools/platform-backends/ section, incorporating three user-facing changes from maui-labs PR #251:

  1. New macOS dotnet new template — documents Microsoft.Maui.Platforms.MacOS.Templates and dotnet new maui-macos
  2. --prerelease flag for all template installs — all three platform template install commands now include --prerelease
  3. macOS namespace and API fix — uses correct using Microsoft.Maui.Platforms.MacOS.Platform; namespace in MauiMacOSApp.cs and includes using Microsoft.Maui.Platforms.MacOS.Essentials; + .AddMacOSEssentials() in MauiProgram.cs

Files changed

  • docs/developer-tools/platform-backends/index.md (new) — Overview with template quick start commands for all three backends and a package reference table
  • docs/developer-tools/platform-backends/macos.md (new) — macOS AppKit backend: prerequisites, packages, template quick start (Option 1), manual setup (Option 2) with corrected namespace and Essentials API
  • docs/developer-tools/platform-backends/linux-gtk4.md (new) — Linux GTK4 backend: prerequisites, GTK4 install commands, packages, template quick start (Option 1), manual setup (Option 2) with --prerelease flag
  • docs/developer-tools/platform-backends/windows-wpf.md (new) — Windows WPF backend: prerequisites, packages, template quick start (Option 1), manual setup (Option 2) with --prerelease flag
  • docs/TOC.yml — Added "Platform backends" section under "Developer tools" with entries for all four new pages
  • docs/developer-tools/index.md — Added "Platform backends" section summary, updated ms.date, added template packages to the packages table

Generated by Docs from Code — Create Draft PR for issue #3311 ·

… backend docs

- Add new docs/developer-tools/platform-backends/ section with four pages:
  - index.md: overview with template quick start for all three backends
  - macos.md: macOS AppKit backend with correct namespace (MacOS.Platform)
              and AddMacOSEssentials() in MauiProgram.cs
  - linux-gtk4.md: Linux GTK4 backend with --prerelease flag on install command
  - windows-wpf.md: Windows WPF backend with --prerelease flag on install command
- Update TOC.yml to add Platform backends section under Developer tools
- Update developer-tools/index.md to mention platform backends and list template packages

Closes #3311

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit b8ba54a:

💡 Validation status: suggestions

File Status Preview URL Details
docs/developer-tools/platform-backends/linux-gtk4.md 💡Suggestion View (>=net-maui-8.0) Details
docs/developer-tools/index.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/platform-backends/index.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/platform-backends/macos.md ✅Succeeded View (>=net-maui-8.0)
docs/developer-tools/platform-backends/windows-wpf.md ✅Succeeded View (>=net-maui-8.0)
docs/TOC.yml ✅Succeeded View (>=net-maui-8.0)

docs/developer-tools/platform-backends/linux-gtk4.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Documentation generated from code changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[maui-labs docs] Update platform backend docs: new macOS template, --prerelease flag for all platform templates, macOS API fixes

0 participants