Skip to content

docs(NavigationXaml): Improving xaml navigation Guide, seperate between Mvvm and Mvux #2742

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

DevTKSS
Copy link
Contributor

@DevTKSS DevTKSS commented Apr 27, 2025

GitHub Issue (If applicable): closes #

PR Type

What kind of change does this PR introduce?

  • Documentation content changes

What is the current behavior?

Mvvm specific guide, but when Mvux should be used, we have a slightly different syntax (...Model instead of ...ViewModel) and the Model could get assumed to be a class instead of a record.
No visual content beside the setup intro

What is the new behavior?

  • Added Mvvm/Mvux specific content by seperation with Dependant Tabs
  • Mvux visual content added
  • Added TODO to the Navigation by NavigationView which should get improved, with Only-Pages Content Sample, while its currently Heading this but not really explaining.

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tested code with current supported SDKs
  • Docs have been added/updated which fit documentation template. (for bug fixes / features)
  • Unit Tests and/or UI Tests for the changes have been added (for bug fixes / features) (if applicable)
  • Wasm UI Tests are not showing unexpected any differences. Validate PR Screenshots Compare Test Run results.
  • Contains NO breaking changes
  • Updated the Release Notes
  • Associated with an issue (GitHub or internal)

Other information

Internal Issue (If applicable):

@DevTKSS DevTKSS force-pushed the mvux-navigation-DI branch from 05c622f to f2ec5cb Compare June 28, 2025 21:11
@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jun 28, 2025

@kazo0 did you/Team see this PR?
Updated it just now. As the current Use NavigationView Guide of the Navigation Extension docs has been, and I would still say it is for a beginner, very complicated to understand and follow this up with the nested Grid Regions and so on. Of course, in cases, where we really want those regions on the same Page, that is a way to do it, but for getting a start point with navigation in a NavigationView, this is not the best way to do learn.

As I created for this need case the YouTube tutorial (currently only German localized but it has Transcripts for automatic Subtitles) I would have also some sourcecode I could use for this as its much simpler than the current approach.
e.g. this is the latest WIP version as I am adding the appropriate docs and Readme to it currently, also in English.
(the current project files are in same directory as the linked file just in case you want to take a Look on how this sample guide used code would look like I think this would may improve the current one...

@DevTKSS DevTKSS changed the title docs(NavigationXaml): Add tabbed content seperating the xaml navigation Guide between Mvvm and Mvux docs(NavigationXaml): Improving xaml navigation Guide, seperate between Mvvm and Mvux Jun 28, 2025
@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jun 30, 2025

@kazo0 what do you say to this latest commits? for a beginner most of the "Advanced" docs for this are more "overloaded" as they are all utilizing the same sample apps solution which is with all of the nested areas (not speaking of routes in general!) quickly overwelming the reader. Its of course good to have one tutorial telling us, how we can set up a navigation with areas in one content like a grid with two rows etc. but its kind of ALL are like this, which makes it really hard to understand whats the endresult.

also, the source code is (was last time I tryed to look it up beginning with it) not matching the tutorial, which disables the reader to make a local clone of the sample and take a look for things that had been left out or not well described.
I think, to all of the xaml methods we can use, there should not only be a complex sample, than also one thats short and clear to follow it up.

@Copilot Copilot AI review requested due to automatic review settings July 27, 2025 14:10
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR improves the XAML navigation documentation by separating MVVM and MVUX approaches with tabbed content, adds visual guides for MVUX, and enhances the NavigationView documentation with additional context and TODO notes for future improvements.

Key Changes:

  • Separated MVVM and MVUX specific guidance using dependent tabs throughout the navigation documentation
  • Added visual content and step-by-step screenshots for MVUX approach
  • Enhanced NavigationView documentation with better explanations and examples

Reviewed Changes

Copilot reviewed 11 out of 15 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
doc/Learn/includes/mvux-approach.md New include file defining MVUX approach note for documentation
doc/Learn/Navigation/includes/register-routes-mvvm.md MVVM-specific route registration code example
doc/Learn/Navigation/includes/register-routes-mvux.md MVUX-specific route registration code example using Model instead of ViewModel
doc/Learn/Navigation/includes/navigation-widgets-inline.md Shared widget navigation example code
doc/Learn/Navigation/includes/navigation-showing-widgets-inline.md Widget display example for navigation data
doc/Learn/Navigation/includes/navigation-data-inline.md Widget record definition for navigation examples
doc/Learn/Navigation/includes/navigate-xaml-request.md Common navigation request explanation
doc/Learn/Navigation/HowTo-NavigateInXAML.md Main navigation guide with MVVM/MVUX tabs and NavigationView content
doc/Learn/Navigation/HowTo-NavigateBetweenPages.md Updated description and fixed typo
doc/Learn/Navigation/Advanced/HowTo-UseNavigationView.md Enhanced NavigationView guide with better explanations and TODO note
doc/Learn/Navigation/Advanced/HowTo-AdvancedPageNavigation.md Converted sections to use tabbed format for consistency

@@ -21,7 +21,7 @@ This topic covers using Navigation to navigate between two pages using frame-bas
Extensions;
+ Navigation;
Toolkit;
MVUX;
MVVX;
Copy link
Preview

Copilot AI Jul 27, 2025

Choose a reason for hiding this comment

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

The text 'MVVX' appears to be a typo. It should be 'MVUX' to match the MVUX approach mentioned throughout the documentation.

Suggested change
MVVX;
MVUX;

Copilot uses AI. Check for mistakes.

@DevTKSS
Copy link
Contributor Author

DevTKSS commented Jul 28, 2025

@mtmattei you mentioned to improve the mvux - Navigation docs last week, would you like to check if you have improvements to be done here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant