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: Fix links resulting in 404 #17705

Merged
merged 19 commits into from
Aug 15, 2024
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/articles/common-issues-all-ides.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Try building your project again.

## Runtime error `No parameterless constructor defined for XXXX`

This error is generally caused by some missing [IL Linker](https://github.com/mono/linker/tree/master/docs) configuration on WebAssembly. You may need to add some of your application assemblies in the LinkerConfig.xml file of your project. You can find [additional information in the documentation](features/using-il-linker-webassembly.md).
This error is generally caused by some missing [IL Linker](https://github.com/dotnet/runtime/tree/main/src/tools/illink) configuration on WebAssembly. You may need to add some of your application assemblies in the LinkerConfig.xml file of your project. You can find [additional information in the documentation](features/using-il-linker-webassembly.md).
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved

Similar error messages using various libraries:

Expand Down
2 changes: 1 addition & 1 deletion doc/articles/concepts/overview/why-uno-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ The Uno Platform provides access to SkiaSharp as a render canvas for your app, e

## Animations: Beyond storyboards, access to Lottie and Rive

Based on SkiaSharp support, Uno Platform provides AnimatedVisualPlayer to give the ability to render rich Lottie files directly in your app, for all target platforms.
Based on SkiaSharp support, Uno Platform provides AnimatedVisualPlayer to give the ability to render rich [Lottie files](https://airbnb.io/lottie/#/) directly in your app, for all target platforms.

## Performance and app size with AOT/Jiterpreter

Expand Down
4 changes: 2 additions & 2 deletions doc/articles/contributing/guidelines/issue-triage.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ Is something unclear? Do we need to improve our documentation or samples?

Community support requests should be directed to:

* Our [documentation](https://platform.uno/docs/) and [troubleshooting guide](https://platform.uno/docs/troubleshooting-guide).
* Our [documentation](https://platform.uno/docs/) and [troubleshooting guide](xref:Uno.UI.CommonIssues).
* [GitHub Discussions](https://github.com/unoplatform/uno/discussions)
* The [Discord Server](https://platform.uno/discord)
* On [Twitter using the #unoplatform](https://twitter.com/search?q=%23unoplatform) hashtag.
* On [X/Twitter using the #unoplatform](https://twitter.com/search?q=%23unoplatform) hashtag.
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved

Organizations that want a deeper level of support beyond community support should be directed to [contact Uno Platform](https://platform.uno/contact/) to discuss obtaining professional support.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ We use Dependabot to notify the team of any updates to dependencies. Once a week

## Internal dependencies

The following dependencies don't change the public API surface and are typically safe to merge and we could potentially [configure mergify to automatically merge them if CI passes](https://medium.com/mergify/merging-bots-pull-requests-automatically-548ed0b4a424):
The following dependencies don't change the public API surface and are typically safe to merge and we could potentially [configure mergify to automatically merge them if CI passes](https://docs.mergify.com/workflow/automerge/):

- BenchmarkDotNet
- [FluentAssertions](https://github.com/unoplatform/uno/pull/1196)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ User inputs are usually propagated using `RoutedEvents`. See Uno's [routed event
| **_manipulation events_**
| `ManipulationStarting` | Yes | Yes | Yes | Yes | [Documentation](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.uielement.manipulationstarting) |
| `ManipulationStarted` | Yes | Yes | Yes | Yes | [Documentation](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.uielement.manipulationstarted) |
| `ManipulationDelta` | Yes | Yes | Yes | Yes | [Documentation](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.uielement.manipulationedelta) |
| `ManipulationDelta` | Yes | Yes | Yes | Yes | [Documentation](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.uielement.manipulationdelta) |
| `ManipulationInertiaStarting` | Yes | Yes | Yes | Yes | [Documentation](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.uielement.manipulationinertiastarting) |
| `ManipulationCompleted` | Yes | Yes | Yes | Yes | [Documentation](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.uielement.manipulationcompleted) |
| **_gesture events_**
Expand Down
2 changes: 1 addition & 1 deletion doc/articles/features/working-with-accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Setting this property does the following:
- On **Android**, it sets the [`View.ContentDescription`](https://developer.android.com/reference/android/view/View.html#setContentDescription(java.lang.CharSequence)) property
- On **iOS**, it sets the [`UIView.AccessibilityIdentifier`](https://developer.apple.com/documentation/uikit/uiaccessibilityidentification/1623132-accessibilityidentifier) property
- On **macOS**, it sets the [`NSView.AccessibilityIdentifier`](https://developer.apple.com/documentation/appkit/nsaccessibility/1535023-accessibilityidentifier) property
- On **WebAssembly**, it sets [`aria-label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-label_attribute) and the `xamlautomationid` property on the HTML element. The [`role`](https://www.w3.org/WAI/PF/HTML/wiki/RoleAttribute) HTML Attribute is also set based on the XAML view type whose `AutomationProperties.AutomationId` was set.
- On **WebAssembly**, it sets [`aria-label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label) and the `xamlautomationid` property on the HTML element. The [`role`](https://www.w3.org/WAI/PF/HTML/wiki/RoleAttribute) HTML Attribute is also set based on the XAML view type whose `AutomationProperties.AutomationId` was set.

This property is generally used alongside [Uno.UITest](https://github.com/unoplatform/Uno.UITest) to create UI Tests, and is particularly useful to select items using data-bound identifiers.

Expand Down
4 changes: 2 additions & 2 deletions doc/articles/getting-started/wizard/includes/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ dotnet new unoapp -http
The Localization extension is responsible for managing globalization in your app.
This enables keeping all translations of your app in a single place and enables the user to easily switch the UI language.

The generated app contains *resw* files which can be used to define the application strings. The defined languages are configured in *appsettings.json*. Follow [this link](Learn.Tutorials.Localization.HowToUseLocalization#3-update-the-ui-culture-with-localizationsettings) to learn how to switch the UI culture.
The generated app contains *resw* files which can be used to define the application strings. The defined languages are configured in *appsettings.json*. Follow [this link](xref:Learn.Tutorials.Localization.HowToUseLocalization#3-update-the-ui-culture-with-localizationsettings) to learn how to switch the UI culture.
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved

![Visual Studio Solution Explorer showing localization files](assets/localization.jpg)
![Visual Studio Solution Explorer showing localization files](../assets/localization.jpg)

The default settings come with the following pre-set languages: English (*en*), Spanish (*es*), French (*fr*), and Portuguese - Brazil (*pt-BR*).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ As discussed earlier, the UWP implementation of the **TimeEntryUno** application
> [!TIP]
> The IdentityServer4 server-side implementation used in the sample mirrors the QuickStart tutorial shown below. :
>
> * [Protecting an API using Client Credentials](http://docs.identityserver.io/en/latest/quickstarts/1_client_credentials.html)
> * [Protecting an API using Client Credentials](https://docs.duendesoftware.com/identityserver/v7/quickstarts/1_client_credentials/)

The code to retrieve the access token is encapsulated within the a class **IdentityServerClient** and uses the **HttpClient** class as well as the **IdentityModel** NuGet package.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The sample application is made up of 3 solutions containing multiple projects an

* Uno.Samples
* reference
* [TimeEntryRia](https://github.com/unoplatform/Uno.Samples/tree/master/reference/TimeEntryRia)
* [TimeEntryRia](https://github.com/unoplatform/Uno.Samples/tree/master/ArchivedProjects/UI/TimeEntryRia/TimeEntryRia)
* UI
* TimeEntry
* [TimeEntryServices](https://github.com/unoplatform/Uno.Samples/tree/master/UI/TimeEntry/TimeEntryServices)
Expand Down
4 changes: 2 additions & 2 deletions doc/articles/migrating-from-xamarin-to-net6.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ There are two ways to migrate an application to .NET 7.

1. In a separate folder, create a new application from the templates using [`dotnet new unoapp -o MyApp`](get-started-dotnet-new.md) (MyApp being of the same name as your existing app), or by using the Visual Studio `Uno Platform App` template
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved
2. Move the `MyApp.Mobile` project folder and include it in your existing solution
3. Make the adjustments to move from the [UWP APIs to the WinUI APIs](updating-to-winui3.ms)
4. Optionally [convert your legacy Xamarin heads](updating-to-winui3.md) to use Uno.WinUI instead of Uno.UI
3. Make the adjustments to move from the [UWP APIs to the WinUI APIs](xref:updating-to-winui3.md)
4. Optionally [convert your legacy Xamarin heads](xref:updating-to-winui3.md) to use Uno.WinUI instead of Uno.UI
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved

## Additional considerations

Expand Down
2 changes: 1 addition & 1 deletion doc/articles/uno-community-toolkit-v7.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ These package ids are for Uno Platform (non-Windows) projects. For WinUI 3 proje
- [Uno.Microsoft.Toolkit.UWP](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.UWP)
- [Uno.Microsoft.Toolkit.Uwp.Notifications](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.Notifications)
- [Uno.Microsoft.Toolkit.Uwp.Services](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.Services)
- [Uno.Microsoft.Toolkit.Uwp.UI.Controls.DataGrid](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.UWP.UI.DataGrid)
- [Uno.Microsoft.Toolkit.Uwp.UI.Controls.DataGrid](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls.DataGrid)
- [Uno.Microsoft.Toolkit.Uwp.UI](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.UWP.UI)
- [Uno.Microsoft.Toolkit.Uwp.UI.Animations](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Animations)
- [Uno.Microsoft.Toolkit.Uwp.UI.Controls](https://www.nuget.org/packages/Uno.Microsoft.Toolkit.Uwp.UI.Controls)
Expand Down
4 changes: 2 additions & 2 deletions doc/articles/uno-development/building-uno-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ This article explains how to build Uno.UI locally, for instance, if you wish to
- Select the **.NET Multi-Platform App UI development`** workload
- Select the **.NET desktop development** workload
- To build the UWP flavor of Uno, you'll need **UWP Development**, install all recent UWP SDKs, starting from 10.0.19041 (or above or equal to `TargetPlatformVersion` line [in this file](https://github.com/unoplatform/uno/blob/master/src/Uno.CrossTargetting.targets))
- Install (**Tools** / **Android** / **Android SDK manager**) all Android SDKs starting from 7.1 (or the Android versions `TargetFrameworks` [list used here](https://github.com/unoplatform/uno/blob/master/src/Uno.UI.BindingHelper.Android/Uno.UI.BindingHelper.Android.csproj))
- Install (**Tools** / **Android** / **Android SDK manager**) all Android SDKs starting from 7.1 (or the Android versions `TargetFrameworks` [list used here](https://github.com/unoplatform/uno/blob/master/src/Uno.UI.BindingHelper.Android/Uno.UI.BindingHelper.Android.netcoremobile.csproj))
- Run [Uno.Check](https://github.com/unoplatform/uno.check) on your dev machine to setup .NET Android/iOS workloads
- Install the version of the .NET SDK specified in [global.json](../../../global.json).
- Install the version of the .NET SDK specified in [global.json](https://github.com/unoplatform/uno/blob/master/global.json).
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved

## Recommended Windows hardware

Expand Down
9 changes: 6 additions & 3 deletions doc/articles/uno-development/contributing-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For the prerequisites you'll need, as well as useful tips like using [solution f

If you're doing development for Uno's macOS support, you'll need to build and run Uno using Visual Studio for Mac. [There's a separate guide for that here](building-uno-macos.md).
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved

You can contribute to Uno directly from your browser using GitPod. [Find out how.](../features/working-with-gitpod.md)
You can contribute to Uno directly from your browser using GitPod, [find out how](../features/working-with-gitpod.md).
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved

Whether you're fixing a bug or working on a new feature, [inspecting the visual tree of a running app](debugging-inspect-visual-tree.md) is often a key step.
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -32,7 +32,7 @@ See [Uno's code conventions and common patterns here](../contributing/guidelines

## Implementing a new feature

See how to implement a new [feature here](../contributing/guidelines/implementing-a-new%20winui-winrt-feature.md).
See how to implement a new [feature here](xref:Uno.Contributing.ImplementWinUIWinRTAPI).

## Experimenting with Samples App

Expand All @@ -52,7 +52,10 @@ See the [Guidelines for creating tests](../contributing/guidelines/creating-test

## Creating a Pull Request

Uno uses [Git](https://git-scm.com/) for version control, and GitHub to host the [main repository](https://github.com/unoplatform/uno). You'll need to know the basics of Git to submit changes to Uno, but never fear, there are plenty of [great](https://git-scm.com/book/en/v2) [guides](https://guides.github.com/introduction/git-handbook/) [available](https://www.atlassian.com/git/tutorials).
Uno uses [Git](https://git-scm.com/) for version control, and GitHub to host the [main repository](https://github.com/unoplatform/uno). You'll need to know the basics of Git to submit changes to Uno, but never fear, there are plenty of great guides available:
[Pro Git book | git-scm](https://git-scm.com/book/en/v2)
[About Git | GitHub](https://guides.github.com/introduction/git-handbook/)
[Tutorials | Atlassian](https://www.atlassian.com/git/tutorials)

> [!IMPORTANT]
> Before you commit your code, take a minute to familiarize yourself with the [Conventional Commits format](git-conventional-commits.md) Uno uses.
Expand Down
4 changes: 2 additions & 2 deletions doc/blog/201809-uno-wasm-intro-part-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ Consuming a WebAssembly module is generally composed of a `.wasm` file and a JS

WebAssembly is mainly trying to solve the issues that makes it difficult to optimize performance for large applications, provide access to binary-producing languages and improve the security of running the resulting code.
morning4coffe-dev marked this conversation as resolved.
Show resolved Hide resolved

WebAssembly modules are defined as self-contained units of byte code. It's possible to use [streaming compilation](https://webassembly.github.io/spec/web-api/index.html#streaming-modules) to concurrently process the byte code as it is being downloaded, unlike Javascript where the source file needs to be fully parsed to make sense.
WebAssembly modules are defined as self-contained units of byte code. It's possible to use [streaming compilation](https://webassembly.github.io/spec/web-api/index.html#streaming-modules) to concurrently process the byte code as it is being downloaded, unlike JavaScript where the source file needs to be fully parsed to make sense.

It also provides a way for any language to have a compilation back-end (such as LLVM and [Emscripten](http://emscripten.org/)) to target the Web. That opens a path for C, C++, Rust, [.NET based languages via Mono](https://github.com/mono/mono/tree/master/sdks/wasm), Java, Go, and many other languages to finally reach the web. It provides choices for developers targeting the Web, whether they need full type safety or not, to reuse that complex C++ library that is proving very difficult to port to Javascript. Such portability also enables runtimes and frameworks to follow, such as [QT-Wasm](https://wiki.qt.io/Qt_for_WebAssembly), and Mono and a very large part of the .NET ecosystem.
It also provides a way for any language to have a compilation back-end (such as LLVM and [Emscripten](http://emscripten.org/)) to target the Web. That opens a path for C, C++, Rust, [.NET based languages via Mono](https://github.com/dotnet/runtime/tree/main/src/mono/wasm), Java, Go, and many other languages to finally reach the web. It provides choices for developers targeting the Web, whether they need full type safety or not, to reuse that complex C++ library that is proving very difficult to port to Javascript. Such portability also enables runtimes and frameworks to follow, such as [QT-Wasm](https://wiki.qt.io/Qt_for_WebAssembly), and Mono and a very large part of the .NET ecosystem.

Security-wise, WebAssembly is very different from previous attempts to run arbitrary binary code in the browser, such as Flash, Java applets, VBA, Silverlight, ActiveX, ... which all had (and continue to have) security and portability issues. For instance, security features include the inability to execute arbitrary memory locations. While this makes optionally JIT'ed languages (such as .NET based languages) a difficult target, it promises a [higher security](https://i.blackhat.com/us-18/Thu-August-9/us-18-Lukasiewicz-WebAssembly-A-New-World-of-Native_Exploits-On-The-Web-wp.pdf) execution environment than its similar add-in based predecessors.

Expand Down
Loading