From fbf403e70dd1b1d646bf092cb6e1438624ed5b22 Mon Sep 17 00:00:00 2001 From: Paul Selormey Date: Wed, 7 Feb 2024 12:39:12 +0900 Subject: [PATCH] Updated documentations - Added Infrastructure section - Updated namespace descriptions --- Docs/articles/Faq.md | 4 ++-- Docs/articles/ReleaseNotes.md | 10 +++++++--- Docs/namespaces/Svg.DataTypes.md | 2 +- Docs/namespaces/Svg.Exceptions.md | 2 +- Docs/namespaces/Svg.ExtensionMethods.md | 2 +- 5 files changed, 12 insertions(+), 8 deletions(-) diff --git a/Docs/articles/Faq.md b/Docs/articles/Faq.md index 179a321f..497c14e5 100644 --- a/Docs/articles/Faq.md +++ b/Docs/articles/Faq.md @@ -116,7 +116,7 @@ Older versions of the package threw a NullReferenceException when calling the Sv ### Using libgdiplus on Ubuntu Linux You can install libgdiplus on Ubuntu Linux using the Quamotion PPA. Follow these steps: -``` +```bash sudo add-apt-repository ppa:quamotion/ppa sudo apt-get update sudo apt-get install -y libgdiplus @@ -128,7 +128,7 @@ On macOS, add a reference to the runtime.osx.10.10-x64.CoreCompat.System.Drawing ```dotnet add package runtime.osx.10.10-x64.CoreCompat.System.Drawing``` When building from source-code you can also uncomment the -``` +```xml diff --git a/Docs/articles/ReleaseNotes.md b/Docs/articles/ReleaseNotes.md index 5c7942c7..7fd8a5c1 100644 --- a/Docs/articles/ReleaseNotes.md +++ b/Docs/articles/ReleaseNotes.md @@ -6,7 +6,7 @@ The release versions are NuGet releases. ### Changes * Added: A class, `SvgOptions`, with external css parameters for styling or transforming the `SvgDocument`. * Added: Support for .NET 4.7.2, .NET 4.8.1 and .NET 8.0. -* [Breaking change] The support for .NET 8 resulted in a breaking change to the signature of methods in `CoordinateParser`. +* [Breaking Change] The support for .NET 8 resulted in a breaking change to the signature of methods in `CoordinateParser`. * The changes are needed to fix a compiler error `CS8352`. * The use of read-only arguments as referenced variable is not necessary. * The use of `ref` in the function arguments resulting in `CS8352` error are all removed. @@ -15,8 +15,12 @@ The release versions are NuGet releases. * made exceptions serializable to be able to cross AppDomain boundaries (see [#826](https://github.com/svg-net/SVG/pull/826)) ### Fixes -* Fixed XML namespace prefixes are also applied for nodes declaring them (see [PR #1106](https://github.com/svg-net/SVG/pull/1106)) -* Fixed Parameter is not valid (see [PR #1131](https://github.com/svg-net/SVG/pull/1131)) +* Fixed: XML namespace prefixes are also applied for nodes declaring them (see [PR #1106](https://github.com/svg-net/SVG/pull/1106)). +* Fixed: Parameter is not valid (see [PR #1131](https://github.com/svg-net/SVG/pull/1131)). + +### Infrastructure +* Moved: The `ReleaseNotes.md` to `Docs/ReleaseNotes.md`. +* Repository clean-up, reducing the download zip size from 22MB to 4.5MB. ### Infrastructure * Split tests SVG/PNG files into Issues and W3C Test Suite. W3C Test Suite files are not automatically downloaded. diff --git a/Docs/namespaces/Svg.DataTypes.md b/Docs/namespaces/Svg.DataTypes.md index daa1faf4..34543de5 100644 --- a/Docs/namespaces/Svg.DataTypes.md +++ b/Docs/namespaces/Svg.DataTypes.md @@ -2,4 +2,4 @@ uid: Svg.DataTypes summary: *content --- -The **Svg.DataTypes** namespace contains classes defining the basic data types used by the SVG-NET library. +The **Svg.DataTypes** namespace contains classes defining the basic data types used by this SVG for .NET library. diff --git a/Docs/namespaces/Svg.Exceptions.md b/Docs/namespaces/Svg.Exceptions.md index 2d41cbca..63668575 100644 --- a/Docs/namespaces/Svg.Exceptions.md +++ b/Docs/namespaces/Svg.Exceptions.md @@ -2,4 +2,4 @@ uid: Svg.Exceptions summary: *content --- -The **Svg.Exceptions** namespace contains .NET exception classes defined by the SVG-NET library. +The **Svg.Exceptions** namespace contains .NET exception classes defined by this SVG for .NET library. diff --git a/Docs/namespaces/Svg.ExtensionMethods.md b/Docs/namespaces/Svg.ExtensionMethods.md index 98626efa..db0adc23 100644 --- a/Docs/namespaces/Svg.ExtensionMethods.md +++ b/Docs/namespaces/Svg.ExtensionMethods.md @@ -2,4 +2,4 @@ uid: Svg.ExtensionMethods summary: *content --- -The **Svg.ExtensionMethods** namespace contains .NET extension classes defined by the SVG-NET library. +The **Svg.ExtensionMethods** namespace contains .NET extension classes defined by this SVG for .NET library.