docs-fix-links-and-lintings and part 1 of todo app tutorial creation #875
Conversation
…ToDo App two nested Readme now Overview to be included in workshops in the future
…KSS/Uno.Samples into docs-fix-links-and-lintings
|
Related to PR's #763 #768 #783 #784 #793 #794 I am currently checking, bugfixing and upgrading the ToDo App to mainly creating a more than source link tutorial for its contents. Since for that its definitely best to check and fix src I am updating it, to current uno extensions standard and minimizing the warnings (better user experience etc.), so it would be good to know if that's maybe meant by this related PR PackageReference is meaning the named one or another thing instead needs to be applyed. Would add the tutorial in a seperate PR then. |
…tityModel.JsonWebTokens
…unknown because it has been added to Programm.cs itself. Instead moved it same as new Uno Logging Extension templated app to the HostBuilder in app.xaml.cs instead The AuthentificationService requiring currently ILogger<AuthentificationService> but placing it in a untyped Logger which could be wrong and schould maybe be also be typed
…h options usage, how it should not be done, guide how this should be done and is done in the ToDo App following at marked place
…ed to uno.extensions.Serialization This Setting is the default for .AddSingleton so this line should not be longer needed
|
@kazo0 this here |
There was a problem hiding this comment.
Pull request overview
This PR improves documentation structure and code quality for the Uno Platform Samples repository. It restructures the ToDo app documentation into a workshop-style tutorial format with separate pages for each topic, fixes various documentation links and formatting issues, and modernizes the ToDo app codebase by migrating from System.IdentityModel.Tokens.Jwt to Microsoft.IdentityModel.JsonWebTokens, adding desktop platform support, and implementing source-generated JSON serialization.
Key Changes
- Documentation Restructure: Converted nested README to Overview.md with table of contents and created individual tutorial pages for ToDo app features (authentication, navigation, localization, theme switching, reactive feeds)
- JWT Library Migration: Updated from
System.IdentityModel.Tokens.Jwt(v7.6.0) toMicrosoft.IdentityModel.JsonWebTokens(v8.7.0) with corresponding code changes throughout - Code Quality Improvements: Enhanced structured logging with proper placeholders, added source-generated JSON serialization contexts, and implemented comprehensive logging configuration
Reviewed changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| reference/TubePlayer/README.md | Fixed indentation and updated links to use aka.platform.uno shortlinks |
| reference/ToDo/toc.yml | New table of contents structure for ToDo app workshop tutorial |
| reference/ToDo/src/ToDo/ToDo.csproj | Added net9.0-desktop target framework and migrated JWT package |
| reference/ToDo/src/ToDo/ServiceCollectionExtensions.cs | Removed temporary serialization options comment and code |
| reference/ToDo/src/ToDo/ReadMe.md | Transformed into in-app getting started guide with xref link to full tutorial |
| reference/ToDo/src/ToDo/Properties/launchSettings.json | Added Desktop and Desktop WSL2 launch profiles |
| reference/ToDo/src/ToDo/Platforms/Desktop/Program.cs | Commented out App.InitializeLogging() call |
| reference/ToDo/src/ToDo/Package.appxmanifest | Changed from tokens to hardcoded executable name |
| reference/ToDo/src/ToDo/GlobalUsings.cs | Updated global usings for new JWT library |
| reference/ToDo/src/ToDo/Configuration/Auth.cs | Added JsonSerializerContext for source generation |
| reference/ToDo/src/ToDo/Business/AuthenticationService.cs | Migrated to JsonWebTokenHandler, improved structured logging, added cancellation token support |
| reference/ToDo/src/ToDo/App.xaml.cs | Added comprehensive logging configuration and source-generated serialization setup |
| reference/ToDo/src/Directory.Packages.props | Updated JWT package version |
| reference/ToDo/doc/*.md | Created six new tutorial documentation pages with code snippet references |
| reference/ToDo/Overview.md | New main overview page replacing README.md with tutorial navigation |
| reference/Counter/Overview.md | Added uid metadata and fixed README link |
| doc/samples.md | Fixed various typos and updated cross-references |
| README.md | Added uid metadata, alt text for logo, and updated links |
| .editorconfig | New editor configuration for consistent formatting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| --- | ||
| uid: Uno.Workshops.ToDo-App.LocalizeByModel | ||
| --- | ||
|
|
||
| # Changing App Localization from Model | ||
|
|
||
| ## The Home Page | ||
|
|
||
| [!code-xaml[](../src/ToDo/Views/HomePage.xaml)] | ||
|
|
||
| ## Code-Behind of Home Page | ||
|
|
||
| [!code-csharp[](../src/ToDo/Views/HomePage.xaml.cs)] | ||
|
|
||
| ## View Model of Home Page | ||
|
|
||
| [!code-csharp[](../src/ToDo/Presentation/HomeViewModel.cs)] |
There was a problem hiding this comment.
I don't think having docs pages here is particularly useful if we are just displaying application code and nothing else
There was a problem hiding this comment.
Same goes for most of the other new .md files in this directory
There was a problem hiding this comment.
@kazo0 you mentioned it to be a possible reference for custom Auth and as its using msal packages from what I saw in the Auth Service, but this sample only has this entry in the Uno Docs
And the ToDo App Blog post I could assume this was coming from is still introducing us to the multi head setup 👀
and its also not even what is shown here 🤷
so the target would have been, to link the appropriate files and add some explaination to each, like what we are seeing and could do with this...
But if we dont want this, feel free to tell what of this you would like to keep, if some or I can also just close this PR and delete the branch.
Could you maybe then check on those other two PR's in this repo, what about those so the stale bot doesn't need to act on them? Thanks 👍
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 27 out of 27 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
prefer aka links over xref links in external repositories Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
DevTKSS
force-pushed
the
docs-fix-links-and-lintings
branch
from
39e6960 to
6e91201
Compare
2 participants
two nested Readme now Overview to be included in workshops in the future
Seperated just src links to be code-csharp blocks allowing dynamically showing src code in the docs along with its explanation.