Updated documentation

Author: rabanti-github

Docs.IndexGenerator/Config/meta-package-config.json

@@ -1,5 +1,5 @@
 {
 "packageName": "PicoXLSX",
 "version": "4.0.0-rc.1",
-"description": "PicoXLSX is a library to generate Microsoft Excel files (XLSX) in an easy and native way. This package is the meta package of PicoXLSX and should be used in most cases as dependency in your project. It used the dependencies of NanoXLSX"
+"description": "PicoXLSX is a library to generate Microsoft Excel files (XLSX) in an easy and native way. This package is the meta package of PicoXLSX and should be used in most cases as dependency in your project. It uses the dependencies of NanoXLSX"
 }

Docs.IndexGenerator/Config/plugin-config.json

@@ -3,13 +3,13 @@
     {
       "id": "NanoXLSX.Core",
       "title": "NanoXLSX.Core API",
-      "path": "NanoXLSX.Core",
+      "path": "https://rabanti-github.github.io/NanoXLSX/NanoXLSX.Core",
       "description": "Core library"
     },
     {
       "id": "NanoXLSX.Writer",
       "title": "NanoXLSX.Writer API",
-      "path": "NanoXLSX.Writer",
+      "path": "https://rabanti-github.github.io/NanoXLSX/NanoXLSX.Writer",
       "description": "Writer component, to save XLSX files"
     }
   ]

Docs.IndexGenerator/Output/index.html

@@ -20,7 +20,7 @@ <h1>
           <h2>API Documentation</h2>
             <section>
             <ul class="list">
-                <li><a href="v2/">PicoXLSX 3.x</a> — Current version</li>
+                <li><a href="v3/">PicoXLSX 3.x</a> — Current version</li>
             </ul>
             </section>
 
@@ -47,7 +47,7 @@ <h1>
           <h2>Meta Package v4.0.0-rc.1</h2>
             <section>
             <ul class="list">
-        <li><strong>PicoXLSX</strong> —  This package is the meta package of PicoXLSX and should be used in most cases as dependency in your project. It used the dependencies of NanoXLSX</li>
+        <li><strong>PicoXLSX</strong> —  This package is the meta package of PicoXLSX and should be used in most cases as dependency in your project. It uses the dependencies of NanoXLSX</li>
 </ul>
 
             <p>There is no documentation for the meta package. Please see the section <b>Dependency Package Documentation</b> for the complete API documentation.</p>
@@ -61,8 +61,8 @@ <h2>Meta Package v4.0.0-rc.1</h2>
         <section>
           <h2>Dependency Package Documentation (NanoXLSX)</h2>
           <ul class="list">
-            <li><a href="NanoXLSX.Core/index.html"><strong>NanoXLSX.Core API</strong></a> — Core library</li>
-        <li><a href="NanoXLSX.Writer/index.html"><strong>NanoXLSX.Writer API</strong></a> — Writer component, to save XLSX files</li>
+            <li><a href="https://rabanti-github.github.io/NanoXLSX/NanoXLSX.Core"><strong>NanoXLSX.Core API</strong></a> — Core library</li>
+        <li><a href="https://rabanti-github.github.io/NanoXLSX/NanoXLSX.Writer"><strong>NanoXLSX.Writer API</strong></a> — Writer component, to save XLSX files</li>
 
           </ul>
         </section>

Docs.IndexGenerator/Program.cs

@@ -109,7 +109,7 @@ static int Main(string[] args)
           <h2>API Documentation</h2>
             <section>
             <ul class=""list"">
-                <li><a href=""v2/"">PicoXLSX 3.x</a> — Current version</li>
+                <li><a href=""v3/"">PicoXLSX 3.x</a> — Current version</li>
             </ul>
             </section>
 
@@ -195,7 +195,15 @@ static string GenerateListItems(PluginConfig cfg)
             var sb = new System.Text.StringBuilder();
             foreach (var e in cfg.Entries)
             {
-                string href = $"{Uri.EscapeDataString(e.Path)}/index.html";
+                string href;
+                if (e.Path.StartsWith("http"))
+                {
+                    href = e.Path;
+                }
+                else
+                {
+                    href = $"{Uri.EscapeDataString(e.Path)}/index.html";
+                }
                 sb.AppendLine($"        <li><a href=\"{href}\"><strong>{EscapeHtml(e.Title)}</strong></a> — {EscapeHtml(e.Description ?? "")}</li>");
             }
             return sb.ToString();

MigrationGuide.md

@@ -9,7 +9,7 @@ There are some breaking changes, that are summarized in this migration guide.
 
 1. The namespace `PicoXLSX` was changed to `NanoXLSX`, to reflect the integration of PicoXLSX into NanoXLSX. Therefore, all occurrences of `PicoXLSX` in the code have to be replaced by `NanoXLSX`.
 2. All sub-classes, like `Cell.Address`, `Style.Font`, etc. are now independent classes. Therefore, all occurrences of these classes have to be adapted in the code, e.g. instead of `Style.Font font = new Font();`, `Font font = new Font();` is used. Additionally, some namespaces, like `NanoXLSX.Styles`, have to be added as usings.
-3. All constanst and enum values were renamed to follow the C# naming conventions (PascalCase for public members). Therefore, all occurrences of these constants and enum values have to be adapted in the code.
+3. All constants and enum values were renamed to follow the C# naming conventions (PascalCase for public members). Therefore, all occurrences of these constants and enum values have to be adapted in the code.
 
 Important to note is, that PicoXLSX can now be extended by adding further NanoXLSX package references. For instance, if `NanoXLSX.Reader` is added as NuGet reference to PicoXLSX, it gets reader functionalities and has basically the same scope as NanoXLSX (Meta-Package).
 
@@ -21,9 +21,9 @@ The following guide lists all necessary changes, as well as changed behaviors of
 
 ### Workbook
 
-  - The method `Workbook.AddStyle(Style)` was completely removed, after marked as obsolete in version 2.x. Styles should be added directly to cells or ranges. 
-  - The method `Workbook.AddStyleComponent(Style, AbstractStyle)` was completely removed, after marked as obsolete in version 2.x. Styles should be modified directly on cells, e.g. `workbook.CurrentWorksheet.Cells["A1"].CellStyle.CurrentFont.Bold = true;` or `workbook.CurrentWorksheet.Cells["A1"].CellStyle.Append(fontStyle)`. 
-  - The methods `Workbook.RemoveStyle(Style)`, `Workbook.RemoveStyle(Style, bool)`, `Workbook.RemoveStyle(string)` and `Workbook.RemoveStyle(string, bool)` were completely removed, after marked as obsolete in version 2.x. Styles should be removed directly from cells (e.g. `workbook.CurrentWorksheet.Cells["A1"].RemoveStyle()`.
+  - The method `Workbook.AddStyle(Style)` was completely removed, after marked as obsolete in version 3.x. Styles should be added directly to cells or ranges. 
+  - The method `Workbook.AddStyleComponent(Style, AbstractStyle)` was completely removed, after marked as obsolete in version 3.x. Styles should be modified directly on cells, e.g. `workbook.CurrentWorksheet.Cells["A1"].CellStyle.CurrentFont.Bold = true;` or `workbook.CurrentWorksheet.Cells["A1"].CellStyle.Append(fontStyle)`. 
+  - The methods `Workbook.RemoveStyle(Style)`, `Workbook.RemoveStyle(Style, bool)`, `Workbook.RemoveStyle(string)` and `Workbook.RemoveStyle(string, bool)` were completely removed, after marked as obsolete in version 3.x. Styles should be removed directly from cells (e.g. `workbook.CurrentWorksheet.Cells["A1"].RemoveStyle()`.
 
 ---
 

PicoXLSX.sln

@@ -1,14 +1,15 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
-VisualStudioVersion = 17.14.36717.8 d17.14
+VisualStudioVersion = 17.14.36717.8
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PicoXLSX", "PicoXLSX\PicoXLSX.csproj", "{A70E40AA-98C1-453A-8030-B4798A89EBFC}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{B02BD3FD-D442-49D4-870B-D59532568417}"
 	ProjectSection(SolutionItems) = preProject
 		Changelog.md = Changelog.md
 		LICENSE = LICENSE
+		MigrationGuide.md = MigrationGuide.md
 		README.md = README.md
 	EndProjectSection
 EndProject

PicoXLSX/PicoXLSX.csproj

@@ -17,7 +17,7 @@
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 		<Title>PicoXLSX (Meta-Package)</Title>
 		<Copyright>Copyright Raphael Stoeckli © 2025</Copyright>
-		<PackageProjectUrl>https://github.com/rabanti-github/NanoXLSX</PackageProjectUrl>
+		<PackageProjectUrl>https://github.com/rabanti-github/PicoXLSX</PackageProjectUrl>
 		<PackageIcon>PicoXLSX.png</PackageIcon>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<RepositoryUrl>https://github.com/rabanti-github/PicoXLSX.git</RepositoryUrl>