diff --git a/docs/content/_index.md b/docs/content/_index.md index f8473419..e99b8a5c 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -8,7 +8,7 @@ description = "A set of .NET libraries for synchronizing data between cloud and The Datasync Community Toolkit is a free [dotnet Foundation] [Community Toolkit] set of libraries that assists in providing offline data to your desktop and mobile applications. The data is stored in the cloud and synchronized to a local Sqlite database. -{{% badge style="primary" title="Version" %}}8.0.3{{% /badge %}} +{{% badge style="primary" title="Version" %}}8.0.4{{% /badge %}} ## Get started diff --git a/docs/content/samples/_index.md b/docs/content/samples/_index.md index bfbf50b5..d113832e 100644 --- a/docs/content/samples/_index.md +++ b/docs/content/samples/_index.md @@ -19,6 +19,5 @@ There are a variety of samples in the [samples folder](https://github.com/Commun * [AvaloniaUI](./todoapp/avalonia.md) * [MAUI](./todoapp/maui.md) - * [Uno Platform](./todoapp/uno.md) * [WinUI3](./todoapp/winui3.md) * [WPF](./todoapp/wpf.md) diff --git a/docs/content/samples/todoapp/_index.md b/docs/content/samples/todoapp/_index.md index 50a67295..08dd11dd 100644 --- a/docs/content/samples/todoapp/_index.md +++ b/docs/content/samples/todoapp/_index.md @@ -6,7 +6,6 @@ title = "Todo App" * [AvaloniaUI](./avalonia.md) * [MAUI](./maui.md) - * [Uno Platform](./uno.md) * [WinUI3](./winui3.md) * [WPF](./wpf.md) diff --git a/docs/content/samples/todoapp/avalonia.md b/docs/content/samples/todoapp/avalonia.md index a8c1e812..f7849b9a 100644 --- a/docs/content/samples/todoapp/avalonia.md +++ b/docs/content/samples/todoapp/avalonia.md @@ -2,32 +2,33 @@ title = "Avalonia" +++ +> [!INFO] +> The Avalonia sample has been kindly contributed to the community by @timunie. + ## Run the application first -The Avalonia sample uses an in-memory Sqlite store for storing its data. The sample can run on Desktop, Mobile and Browser. To run the application locally: +The Avalonia sample uses an in-memory Sqlite store for storing its data. To run the application locally: -* [Configure Visual Studio for Avalonia development](https://docs.avaloniaui.net/docs/welcome). +* [Configure Visual Studio for Avalonia development](https://docs.avaloniaui.net/docs/get-started). * Open `samples/todoapp/Samples.TodoApp.sln` in Visual Studio. -* In the Solution Explorer, expand the folder `TodoApp.Avalonia` and right-click the `TodoApp.Avalonia.Desktop` project, then select **Set as Startup Project**. +* In the Solution Explorer, expand the `TodoApp.Avalonia` folder, then right-click the `TodoApp.Avalonia.Desktop` project, then select **Set as Startup Project**. * Select a target (in the top bar), then press F5 to run the application. -> [!TIP] -> We suggest to start testing and debugging using the Desktop App first. Once you feel confident, you can also try out Mobile or Browser version. +If you bump into issues at this point, ensure you can properly develop and run Avalonia applications for the desktop outside of the datasync service. -> [!NOTE] -> If you bump into issues at this point, please visit [Avalonia.Docs](https://docs.avaloniaui.net) and [Avalonia.Samples](https://github.com/AvaloniaUI/Avalonia.Samples) for some basic getting-started tutorials. +> [!TIP] +> The TodoApp.Avalonia sample is known to work on Android and Desktop. We have not tested on other platforms. This is how the sample will look like:  - ## Deploy a datasync server to Azure Before you begin adjusting the application for offline usage, you must [deploy a datasync service](../server.md). Make a note of the URI of the service before continuing. ## Update the application for datasync operations -All the changes are isolated to the `Database/AppDbContext.cs` file. +All the changes are isolated to the `Database/AppDbContext.cs` file in the `TodoApp.Avalonia` shared project. 1. Change the definition of the class so that it inherits from `OfflineDbContext`: @@ -77,4 +78,7 @@ All the changes are isolated to the `Database/AppDbContext.cs` file. You can now re-run your application. Watch the console logs to show the interactions with the datasync service. Press the refresh button to synchronize data with the cloud. When you restart the application, your changes will automatically populate the database again. +> [!TIP] +> The first synchronization can take a while because of the cold-start of the service. Watch the debug output to see the synchronization happening. + Obviously, you will want to do much more in a "real world" application, including proper error handling, authentication, and using a Sqlite file instead of an in-memory database. This example shows off the minimum required to add datasync services to an application. diff --git a/docs/content/samples/todoapp/maui.md b/docs/content/samples/todoapp/maui.md index daa045cc..c21bfcf5 100644 --- a/docs/content/samples/todoapp/maui.md +++ b/docs/content/samples/todoapp/maui.md @@ -11,7 +11,10 @@ The MAUI sample uses an in-memory Sqlite store for storing its data. To run the * In the Solution Explorer, right-click the `TodoApp.MAUI` project, then select **Set as Startup Project**. * Select a target (in the top bar), then press F5 to run the application. -The application runs on Android, iOS, and Windows. Each platform needs slightly different setup. Read the MAUI documentation for more information. +The application should run on Android, iOS, and Windows. Each platform needs slightly different setup. Read the MAUI documentation for more information. + +> [!TIP] +> The TodoApp.MAUI sample is known to work on Android and Desktop. We have not tested on other platforms. ## Deploy a datasync server to Azure @@ -69,4 +72,7 @@ All the changes are isolated to the `Database/AppDbContext.cs` file. You can now re-run your application. Watch the console logs to show the interactions with the datasync service. Press the refresh button to synchronize data with the cloud. When you restart the application, your changes will automatically populate the database again. +> [!TIP] +> The first synchronization can take a while because of the cold-start of the service. Watch the debug output to see the synchronization happening. + Obviously, you will want to do much more in a "real world" application, including proper error handling, authentication, and using a Sqlite file instead of an in-memory database. This example shows off the minimum required to add datasync services to an application. diff --git a/docs/content/samples/todoapp/winui3.md b/docs/content/samples/todoapp/winui3.md index a5933e8e..35350c59 100644 --- a/docs/content/samples/todoapp/winui3.md +++ b/docs/content/samples/todoapp/winui3.md @@ -69,4 +69,7 @@ All the changes are isolated to the `Database/AppDbContext.cs` file. You can now re-run your application. Watch the console logs to show the interactions with the datasync service. Press the refresh button to synchronize data with the cloud. When you restart the application, your changes will automatically populate the database again. +> [!TIP] +> The first synchronization can take a while because of the cold-start of the service. Watch the debug output to see the synchronization happening. + Obviously, you will want to do much more in a "real world" application, including proper error handling, authentication, and using a Sqlite file instead of an in-memory database. This example shows off the minimum required to add datasync services to an application. diff --git a/docs/content/samples/todoapp/wpf.md b/docs/content/samples/todoapp/wpf.md index bd911fac..cc9428b3 100644 --- a/docs/content/samples/todoapp/wpf.md +++ b/docs/content/samples/todoapp/wpf.md @@ -69,4 +69,7 @@ All the changes are isolated to the `Database/AppDbContext.cs` file. You can now re-run your application. Watch the console logs to show the interactions with the datasync service. Press the refresh button to synchronize data with the cloud. When you restart the application, your changes will automatically populate the database again. +> [!TIP] +> The first synchronization can take a while because of the cold-start of the service. Watch the debug output to see the synchronization happening. + Obviously, you will want to do much more in a "real world" application, including proper error handling, authentication, and using a Sqlite file instead of an in-memory database. This example shows off the minimum required to add datasync services to an application. diff --git a/docs/public/404.html b/docs/public/404.html index 15ceb58c..538db34a 100644 --- a/docs/public/404.html +++ b/docs/public/404.html @@ -3,7 +3,7 @@
- + @@ -20,17 +20,17 @@ - - - - - - - - - - - + + + + + + + + + + + - + @@ -20,17 +20,17 @@ - - - - - - - - - - - + + + + + + + + + + + - - - - - - + + + + + +