Link to new documentation website from the README (#511)

Author: adamreeve

.github/workflows/publish-docs.yml

@@ -35,11 +35,12 @@ jobs:
 
     - name: Build Documentation
       run: docfx docfx.json
+      working-directory: ./docs
 
     - name: Upload Site Artifact
       uses: actions/upload-pages-artifact@v3
       with:
-        path: '_site'
+        path: './docs/_site'
 
     - name: Deploy to GitHub Pages
       uses: actions/deploy-pages@v4

.gitignore

@@ -4,10 +4,7 @@ obj
 nuget
 BenchmarkDotNet.Artifacts
 .vs
-_site
-api
-.manifest
 
 # The solution files get generated by vcpkg on Windows
 # and by the C# Dev Kit within a dev container.
-*.sln
+*.sln

README.md

@@ -35,7 +35,7 @@ Supported platforms:
 
 The following examples show how to write and then read a Parquet file with three columns representing a timeseries of object-value pairs.
 These use the low-level API, which is the recommended API for working with native .NET types and closely maps to the API of Apache Parquet C++.
-For reading and writing data in the [Apache Arrow](https://arrow.apache.org/) format, an [Arrow-based API](docs/Arrow.md) is also provided.
+For reading and writing data in the [Apache Arrow](https://arrow.apache.org/) format, an [Arrow-based API](https://g-research.github.io/ParquetSharp/guides/Arrow.html) is also provided.
 
 ### 1. Initialize a new project
 
@@ -159,18 +159,7 @@ Timestamp: 2025-01-25 10:16:25 AM, ObjectId: 2, Value: 4.56
 
 ## Documentation
 
-For more detailed information on how to use ParquetSharp, see the following documentation:
-
-* [Writing Parquet files](docs/Writing.md)
-* [Reading Parquet files](docs/Reading.md)
-* [Working with nested data](docs/Nested.md)
-* [Reading and writing Arrow data](docs/Arrow.md) — how to read and write data using the [Apache Arrow format](https://arrow.apache.org/)
-* [Row-oriented API](docs/RowOriented.md) — a higher level API that abstracts away the column-oriented nature of Parquet files
-* [Custom types](docs/TypeFactories.md) — how to customize the mapping between .NET and Parquet types,
-    including using the `DateOnly` and `TimeOnly` types added in .NET 6.
-* [Encryption](docs/Encryption.md) — using Parquet Modular Encryption to read and write encrypted data
-* [Writing TimeSpan data](docs/TimeSpan.md) — interoperability with other libraries when writing TimeSpan data
-* [Use from PowerShell](docs/PowerShell.md)
+For more detailed guides on how to use ParquetSharp and an API reference, please see [the documentation](https://g-research.github.io/ParquetSharp/).
 
 ## Rationale
 

docs/.gitignore

@@ -0,0 +1,2 @@
+_site
+api

docfx.json renamed to docs/docfx.json

@@ -4,13 +4,13 @@
     {
       "src": [
         {
-          "src": "./csharp",
+          "src": "../csharp",
           "files": [
             "**/*.csproj"
           ]
         }
       ],
-      "dest": "api",
+      "dest": "api"
     }
   ],
   "build": {
@@ -27,7 +27,7 @@
     "resource": [
       {
         "files": [
-          "images/**"
+          "images/*"
         ]
       }
     ],
@@ -37,12 +37,17 @@
       "modern"
     ],
     "globalMetadata": {
-      "_appFaviconPath": "images/logo/svg/ParquetSharp_IconLogo_RGB-Black.svg",
-      "_appLogoPath": "images/logo/svg/ParquetSharp_IconLogo_RGB-Black_small.svg",
+      "_appFaviconPath": "images/favicon.svg",
+      "_appLogoPath": "images/logo.svg",
       "_appName": "ParquetSharp",
       "_appTitle": "ParquetSharp",
       "_enableNewTab": true,
       "_enableSearch": true
+    },
+    "markdownEngineProperties": {
+      "markdigExtensions": [
+        "attributes"
+      ]
     }
   }
-}
+}

docs/Arrow.md renamed to docs/guides/Arrow.md

@@ -156,5 +156,6 @@ private sealed class CustomTypeFactory : LogicalTypeFactory
 
 ### Learn More
 
-Check [TestLogicalTypeFactory.cs](../csharp.test/TestLogicalTypeFactory.cs) for a more comprehensive set of examples,
+Check [TestLogicalTypeFactory.cs](https://github.com/G-Research/ParquetSharp/blob/master/csharp.test/TestLogicalTypeFactory.cs)
+for a more comprehensive set of examples,
 as there are many places that can be customized and optimized by the user.

docs/Encryption.md renamed to docs/guides/Encryption.md

@@ -0,0 +1,18 @@
+- name: Reading Parquet
+  href: Reading.md
+- name: Writing Parquet
+  href: Writing.md
+- name: Arrow API
+  href: Arrow.md
+- name: Row-Oriented API
+  href: RowOriented.md
+- name: Nested Data
+  href: Nested.md
+- name: Encryption
+  href: Encryption.md
+- name: Type Factories
+  href: TypeFactories.md
+- name: Time Span Handling
+  href: TimeSpan.md
+- name: Use from PowerShell
+  href: PowerShell.md