Merge pull request #201 from MADE-Apps/feature/docs

Improvements to MADE.NET landing page

Author: jamesmcroft

.github/workflows/docs.yml

@@ -18,12 +18,12 @@ on:
 
 jobs:
   generate-docs:
-  
+
     runs-on: windows-latest
 
     steps:
     - uses: actions/checkout@v2
-    
+
     - name: Setup .NET Core 3.1
       uses: actions/setup-dotnet@v1
       with:
@@ -33,17 +33,22 @@ jobs:
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: 5.0.x
-        
+
+    - name: Setup .NET 6.0
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 6.0.x
+
     - name: Setup DocFX
       uses: crazy-max/ghaction-chocolatey@v1
       with:
         args: install docfx
-    
+
     - name: DocFX Build
       working-directory: docs
       run: docfx .\docfx.json
       continue-on-error: false
-      
+
     - name: Publish
       if: github.event_name == 'push'
       uses: peaceiris/actions-gh-pages@v3

docs/articles/available-packages.md

@@ -1,6 +1,6 @@
 ---
 uid: available-packages
-title: Available packages | MADE.NET
+title: Available packages
 ---
 
 # Available MADE.NET packages

docs/articles/features/collections.md

@@ -1,6 +1,6 @@
 ---
 uid: package-collections
-title: Using the Collections package | MADE.NET
+title: Using the Collections package
 ---
 
 # Using the Collections package

docs/articles/features/data-converters.md

@@ -1,6 +1,6 @@
 ---
 uid: package-data-converters
-title: Using the Data Converters package | MADE.NET
+title: Using the Data Converters package
 ---
 
 # Using the Data Converters package
@@ -104,4 +104,4 @@ namespace MADE.Data.Converters
 
 If you want to build a XAML specific value converter, you can also apply the `Windows.UI.Xaml.Data.IValueConverter` to your class and implement the additional methods calling directly into your `Convert` and `ConvertBack` methods.
 
-If there is a common value converter you think is missing from MADE.NET, [raise a tracking item on GitHub](https://github.com/MADE-Apps/MADE.NET/issues/new/choose) and we'll get it implemented.
+If there is a common value converter you think is missing from MADE.NET, [raise a tracking item on GitHub](https://github.com/MADE-Apps/MADE.NET/issues/new/choose) and we'll get it implemented.

docs/articles/features/data-efcore.md

@@ -1,6 +1,6 @@
 ---
 uid: package-data-converters
-title: Using the Data Converters package | MADE.NET
+title: Using the Data Converters package
 ---
 
 # Using the Data Entity Framework Core package

docs/articles/features/data-validation.md

@@ -1,6 +1,6 @@
 ---
 uid: package-data-validation
-title: Using the Data Validation package | MADE.NET
+title: Using the Data Validation package
 ---
 
 # Using the Data Validation package

docs/articles/features/diagnostics.md

@@ -1,6 +1,6 @@
 ---
 uid: package-diagnostics
-title: Using the Diagnostics package | MADE.NET
+title: Using the Diagnostics package
 ---
 
 # Using the Diagnostics package
@@ -63,4 +63,4 @@ Logs will be created for each handle of an unhandled exception from one or more
 
 The `AppDiagnostics` helper exposes its own event handler `ExceptionObserved` that can be used in your own application code if you wish to perform additional actions when an exception is logged. 
 
-The event argument provided by this handler will include the correlation ID to the event in the log, as well as the exception that was thrown.
+The event argument provided by this handler will include the correlation ID to the event in the log, as well as the exception that was thrown.

docs/articles/features/media-image.md

@@ -1,6 +1,6 @@
 ---
 uid: package-media-image
-title: Using the Media Image package | MADE.NET
+title: Using the Media Image package
 ---
 
 # Using the Media Image package
@@ -40,4 +40,4 @@ You can do this in your Windows XAML as shown below.
 
 This could result in a generated UI that looks like this.
 
-<img src="../../images/ImageBehavior.png" alt="Result of using LoadStorageFileThumbnailImageBehavior" />
+<img src="../../images/ImageBehavior.png" alt="Result of using LoadStorageFileThumbnailImageBehavior" />

docs/articles/features/networking.md

@@ -1,6 +1,6 @@
 ---
 uid: package-networking
-title: Using the Networking package | MADE.NET
+title: Using the Networking package
 ---
 
 # Using the Networking package
@@ -84,4 +84,4 @@ public void UpdateProfileDetails(Profile profile)
 
 `NetworkRequest` objects have a `Guid` identifier also, so if you need to update a pending request with different data or a change in URL, you can do simply by recalling `NetworkManager.AddOrUpdate` passing in a network request with the same ID.
 
-The `AddOrUpdate` method has overloads for providing a success callback, as well as an error callback. This allows you to make decisions in your code to handle a successful or failed network request.
+The `AddOrUpdate` method has overloads for providing a success callback, as well as an error callback. This allows you to make decisions in your code to handle a successful or failed network request.

docs/articles/features/runtime.md

@@ -1,6 +1,6 @@
 ---
 uid: package-runtime
-title: Using the Runtime package | MADE.NET
+title: Using the Runtime package
 ---
 
 # Using the Runtime package
@@ -31,4 +31,4 @@ public void AddOrUpdate<TRequest, TResponse, TErrorResponse>(
 }
 ```
 
-In the above example, an action can be passed from a requesting object for when a network request is a success or errors. By using a `WeakReferenceCallback` instead of keeping a hold on the action reference, the requesting object can be disposed when it is no longer required. This is useful in application development scenarios, for example, a page view-model.
+In the above example, an action can be passed from a requesting object for when a network request is a success or errors. By using a `WeakReferenceCallback` instead of keeping a hold on the action reference, the requesting object can be disposed when it is no longer required. This is useful in application development scenarios, for example, a page view-model.