Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Mapping (Xamarin.Essentials)/.NET MAUI Platform APIs to WinRT APIs #16665

Open
agneszitte opened this issue May 9, 2024 · 0 comments
Labels
difficulty/tbd Categorizes an issue for which the difficulty level needs to be defined. kind/documentation triage/untriaged Indicates an issue requires triaging or verification

Comments

@agneszitte
Copy link
Contributor

agneszitte commented May 9, 2024

Description

The .NET MAUI documentation currently includes information on Platform APIs, which were formerly known as Essentials.
https://learn.microsoft.com/en-us/dotnet/maui/platform-integration/?view=net-maui-8.0
To aid developers transitioning from (Xamarin.Essentials)/.NET MAUI Platform APIs to WinRT APIs, a comprehensive guide is essential.
This guide should detail the API mappings, supported platforms, and necessary setup, and include practical usage examples.

Proposed content for this guide

  1. API Mapping Guide

    • Develop a detailed correspondence table or list mapping each (Xamarin.Essentials)/.NET MAUI Platform APIs to the WinRT APIs counterpart.
    • Highlight differences in API functionality or any limitations.
  2. Platform Support

    • Document the supported platforms for each of those.
    • Note any platforms that are no longer supported or have known issues as needed.
  3. Setup Instructions

    • Provide detailed setup instructions for each platform to assist developers in transitioning their projects.
  4. Usage Examples

    • Include samples & code examples showing how to utilize WinRT APIs to replace (Xamarin.Essentials)/.NET MAUI Platform functionalities.
    • Focus on common use cases previously handled by (Xamarin.Essentials)/.NET MAUI Platform functionalities.

cc @dansiegel, @jeromelaban

@agneszitte agneszitte added triage/untriaged Indicates an issue requires triaging or verification difficulty/tbd Categorizes an issue for which the difficulty level needs to be defined. kind/documentation labels May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty/tbd Categorizes an issue for which the difficulty level needs to be defined. kind/documentation triage/untriaged Indicates an issue requires triaging or verification
Projects
None yet
Development

No branches or pull requests

1 participant