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

[Doc] ContentDialog documentation needs improvements #16327

Open
agneszitte opened this issue Apr 17, 2024 · 1 comment
Open

[Doc] ContentDialog documentation needs improvements #16327

agneszitte opened this issue Apr 17, 2024 · 1 comment
Labels
difficulty/starter 🚀 Categorizes an issue for which the difficulty level is reachable by newcomers kind/documentation project/documentation 📖 Categorizes an issue or PR as relevant to documentation

Comments

@agneszitte
Copy link
Contributor

agneszitte commented Apr 17, 2024

On which page?

https://platform.uno/docs/articles/controls/ContentDialog.html

What's wrong?

ContentDialog documentation needs improvements based on the feedback received on Discord here

Key Points from the feedback:

  • Lack of Examples: There are no clear examples or documentation on how to open a ContentDialog with a Command using C# Markup and MVUX. Current examples focus primarily on XAML or are too specific to other contexts (like the Counter tutorial).
  • Access to XamlRoot: How to access XamlRoot in scenarios where the command is located in the "MainModel", which does not have access to XamlRoot property.

Suggested Improvements:

  • Detailed Examples: Add comprehensive examples showing the use of C# Markup and MVUX/MVVM for opening ContentDialogs. Would be best to use Tabs in the documentation in order to showcase the different possibilities ([XAML][C# Markup] & [MVUX][MVVM])
  • Add details pointing to the usage of Uno's Navigation Extensions documentation here, where there is the NavigationService with all the abstractions needed to inject the navigation service into the model.
@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 Apr 17, 2024
@MartinZikmund MartinZikmund changed the title [Doc] ContentDialog documentation needs improvements [Doc] ContentDialog documentation needs improvements Apr 18, 2024
@MartinZikmund
Copy link
Member

I recently made this doc,https://github.com/unoplatform/uno/blob/master/doc/articles/features/dialogs.md , so it seems we now have similar information in two places, probably the existing info in the controls one should be moved to features doc

@MartinZikmund MartinZikmund added project/documentation 📖 Categorizes an issue or PR as relevant to documentation difficulty/starter 🚀 Categorizes an issue for which the difficulty level is reachable by newcomers and removed triage/untriaged Indicates an issue requires triaging or verification difficulty/tbd Categorizes an issue for which the difficulty level needs to be defined. labels Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty/starter 🚀 Categorizes an issue for which the difficulty level is reachable by newcomers kind/documentation project/documentation 📖 Categorizes an issue or PR as relevant to documentation
Projects
None yet
Development

No branches or pull requests

2 participants