Skip to content

Commit bee63ae

Browse files
MikeCodesDotNETMikeCodesDotNET
committed
Tweaking the XPF docs
Adding more context and a welcome page
1 parent 885951f commit bee63ae

File tree

9 files changed

+113
-17
lines changed

9 files changed

+113
-17
lines changed

‎docusaurus.config.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,13 @@ const config = {
186186
},
187187
items: [
188188
{
189-
label: 'Documentation',
189+
label: 'Avalonia Docs',
190190
to: '/docs/welcome'
191191
},
192+
{
193+
label: 'XPF Docs',
194+
to: '/xpf/welcome',
195+
},
192196
{
193197
label: 'Resources',
194198
type: 'dropdown',
@@ -201,10 +205,6 @@ const config = {
201205
},
202206
],
203207
},
204-
{
205-
label: 'Avalonia XPF',
206-
to: '/xpf/getting-started',
207-
},
208208
{
209209
label: 'Support',
210210
to: 'https://avaloniaui.net/support',

‎xpf-sidebar.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
const sidebars = {
55

66
documentationSidebar: [
7+
'welcome',
78
'getting-started',
89
'porting-tips',
910
'build-feeds',
@@ -14,7 +15,8 @@ const sidebars = {
1415
'label': 'Platforms',
1516
'items': [
1617
'platforms/linux',
17-
'platforms/macos'
18+
'platforms/macos',
19+
'platforms/mobile-and-browser'
1820
]
1921
},
2022
{
@@ -44,8 +46,7 @@ const sidebars = {
4446
'advanced/customizing-window-decorations',
4547
'advanced/headless-testing',
4648
'advanced/key-mapping',
47-
'advanced/window-handles',
48-
'advanced/running-on-mobile-and-browser'
49+
'advanced/window-handles'
4950
]
5051
},
5152
'troubleshooting',

‎xpf/build-feeds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: build-feeds
33
title: XPF Versioning
44
---
55

6-
The latest stable version of Avalonia XPF is 1.2.0. And if you are planning to make a release of your product you should choose the stable version. But for development purposes you may want to update to the latest development version frequently. The latest version can be found on our [nuget server](https://xpf-nuget-feed.avaloniaui.net/packages/xpf.sdk).
6+
The latest stable version of Avalonia XPF is 1.3.0. And if you are planning to make a release of your product you should choose the stable version. But for development purposes you may want to update to the latest development version frequently. The latest version can be found on our [nuget server](https://xpf-nuget-feed.avaloniaui.net/packages/xpf.sdk).
77

88
To log into the web portal, use the following credentials:
99

‎xpf/embedding/web-view.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: web-view
3-
title: Using Web View control
3+
title: Using WebView control
44
---
55

66
## Overview

‎xpf/missing-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ While XPF makes a best attempt to implement all WPF APIs, there are still some p
77

88
The following features are available, but with limitations:
99

10+
- `WebBrowser` see our [WebView docs](embedding/web-view)
1011
- `FlowDocument`
1112
- Paginated documents are not supported
1213
- `PageHeader`/`PageFooter` are not supported
@@ -15,7 +16,6 @@ The following features are available, but with limitations:
1516

1617
The following features will be available later but require significant engineering effort:
1718

18-
- `WebBrowser`
1919
- `Viewport3D` and related 3D APIs
2020

2121
The following features are unlikely to be supported due to platform restrictions:

‎xpf/platforms/linux.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,25 @@ id: linux
33
title: Linux
44
---
55

6+
## Supported Distributions
7+
We maintain comprehensive testing and support for the following Linux distributions:
8+
9+
* **Debian**: Version 9 and newer
10+
* **Ubuntu**: Version 16.04 and newer
11+
* **Fedora**: Version 30 and newer
12+
13+
### Other Distributions
14+
While we focus our testing efforts on the distributions listed above, Avalonia XPF can run on many other Linux distributions. If you're using a distribution that's not listed in our officially supported platforms:
15+
16+
* We will work with you to ensure compatibility with your chosen distribution
17+
* Our support team can assist with distribution-specific issues
18+
* The distribution may require additional configuration or testing
19+
20+
:::note
21+
Distribution-specific support is provided on a case-by-case basis. We recommend reaching out to our support team early in your development process if you plan to deploy on a non-listed distribution.
22+
:::
23+
24+
625
## Installing .NET
726

827
Many distributions provide a version of .NET in their package repositories, but these **should not** be used as they do not ship the required `Microsoft.NET.Sdk.WindowsDesktop` SDK.

‎xpf/advanced/running-on-mobile-and-browser.md renamed to ‎xpf/platforms/mobile-and-browser.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
id: running-on-mobile-and-browser
3-
title: Running on Mobile and Browser
2+
id: mobile-and-browser
3+
title: Mobile and Browser
44
---
55

66
:::danger
7-
XPF support for Mobile and Browser targets is in early stages.
8-
As well as it highly depends on app complexity and dependencies.
7+
XPF support for Mobile and Browser targets is in private-preview.
98
:::
109

1110
:::tip

‎xpf/third-party-libraries.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ title: Third party libraries
44
---
55

66
Avalonia XPF implements WPF's API surface, however a variety of third party libraries also depend on various win32 APIs which are obviously not available cross-platform.
7-
To deal with this problem, Avalonia XPF implements a win32 API emulation layer that allows 3rd party libraries to work on non-windows platforms. This emulation
8-
layer needs to be enabled explictly in your XPF application.
7+
8+
To deal with this problem, Avalonia XPF implements a win32 API emulation layer that allows 3rd party libraries to work on non-windows platforms. This emulation layer needs to be enabled explictly in your XPF application.
99

1010
This feature must be enabled before any assembly attempts to call a win32 API, so the constructor of your `App` class or `Program.Main` is a good place to enable it.
1111

@@ -35,3 +35,17 @@ AvaloniaUI.Xpf.WinApiShim.WinApiShimSetup
3535
.AddLibrary(typeof(Type.In.Third.Party.Library).Assembly);
3636
```
3737

38+
## Compatibility Database
39+
40+
We maintain a comprehensive [compatibility database](avaloniaui.net/xpf/packages) for third-party controls. This database provides up-to-date status information for controls from major vendors.
41+
42+
:::info
43+
If you find that a control marked as `Fix In Progress` or `Untested` is mission-critical for your application, please contact our support team. We're committed to working with you to ensure compatibility.
44+
:::
45+
46+
### Compatibility Notes
47+
48+
* **Pure WPF Controls**: Third-party controls that are implemented purely in WPF typically work without any issues, even if not listed in our compatibility database.
49+
* **Unlisted Vendors**: The absence of a control vendor from our database doesn't indicate incompatibility. We encourage you to test any controls you need.
50+
* **Known Challenges**: Issues most commonly arise with controls that utilize GDI or WinForms components.
51+

‎xpf/welcome.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
id: welcome
3+
title: Welcome
4+
sidebar_label: Welcome
5+
---
6+
7+
Welcome to the documentation for Avalonia XPF, our cross-platform fork of WPF.
8+
9+
## Overview
10+
11+
Avalonia XPF is a powerful solution that enables WPF applications to run natively across multiple platforms, including Windows, macOS, and Linux, with upcoming support for iOS, Android, and WebAssembly.
12+
13+
Avalonia XPF maintains both API and binary compatibility with WPF while replacing the low-level WPF implementation (MilCore) with Avalonia's cross-platform rendering engine. This approach allows developers to migrate their existing WPF applications to other platforms with minimal code changes, preserving their investment in WPF development and third-party controls.
14+
15+
## Licensing
16+
17+
As a commercial product, Avalonia XPF offers different licensing tiers to suit various needs:
18+
19+
| Platform | Indie | Business | Enterprise |
20+
|---------------|-------|-------|-------|
21+
| `Windows` | ✔ | ✔ | ✔ |
22+
| `macOS` | ✔ | ✔ | ✔ |
23+
| `Desktop Linux` | ✖ | ✔ | ✔ |
24+
| `Embedded Linux` | ✖ | ✖ | ✔ |
25+
| `iOS` | ✖ | ✖ | ✔ |
26+
| `Android` | ✖ | ✖ | ✔ |
27+
| `WebAssembly` | ✖ | ✖ | ✔ |
28+
29+
All applications built with Avalonia XPF will continue to work in perpetuity, regardless of license status. This ensures that your deployed applications remain functional and stable for your end users.
30+
31+
### Indie Licenses
32+
The Indie license is offered as an annual subscription and includes:
33+
34+
* 30-day money-back guarantee
35+
* Full access to Avalonia XPF features on Windows & macOS
36+
37+
If an Indie license expires, developers will no longer be able to build new versions of their applications using XPF. However, all previously built applications will continue to function normally.
38+
39+
### Business & Enterprise Licenses
40+
Business and Enterprise licenses are perpetual, offering a permanent right to use Avalonia XPF. These licenses include:
41+
42+
* Fully supported 30-day trial period
43+
* Permanent license to build with Avalonia XPF
44+
* 12 months of updates and engineering support
45+
46+
Both Business and Enterprise licenses enable organizations to thoroughly evaluate XPF's capabilities through a supported trial period, ensuring compatibility with their existing applications across their target platforms.
47+
48+
### Trial Availability
49+
Trial periods are exclusively available for Business and Enterprise licenses. These trials are fully supported by our engineering team to ensure organizations can thoroughly evaluate XPF's capabilities with their specific applications and use cases.
50+
51+
For Indie developers, we offer a 30-day money-back guarantee instead of a trial period. This approach allows developers to test XPF's compatibility with their projects while ensuring they receive the appropriate level of support for their needs. We ask that Indie developers not apply for Business or Enterprise trials.
52+
53+
### Pricing
54+
For the latest pricing, please see our [website](https://avaloniaui.net/xpf#pricing).
55+
56+
## Hybrid XPF
57+
One of Avalonia XPF's unique features is its [hybrid capability](embedding/xpf-in-avalonia.md), allowing Avalonia developers to use WPF controls within applications. This flexibility enables Avalonia developers to leverage over 700 existing WPF controls from major vendors such as [Telerik](https://www.telerik.com/), [Actipro](https://www.actiprosoftware.com/), [DevExpress](https://www.devexpress.com/), [Infragistics](https://www.infragistics.com/), and [Syncfusion](https://www.syncfusion.com/), bridging the gap between traditional WPF development and modern cross-platform applications.
58+
59+
## Get Started
60+
Begin your journey with Avalonia XPF using our comprehensive [getting started guide](getting-started), which walks you through the straightforward process of migrating your WPF application to run on additional platforms in just minutes.
61+
62+
63+

0 commit comments

Comments
 (0)