[DOCS]: Fix both the welcome page and readme (#65)

* Create draft PR for #64 * Fix readme and document links --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Matt Edwards <[email protected]>
Stillpoint-Software · Aug 1, 2024 · a734235 · a734235
1 parent ceaf1bd
commit a734235
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -20,29 +20,28 @@ JSONPath is a query language for JSON, allowing you to navigate and extract data
 Hyperbee.Json's JSONPath implementation is designed for optimal performance, ensuring low memory allocations and fast query execution. 
 It fully conforms to [RFC 9535](https://www.rfc-editor.org/rfc/rfc9535.html).
 
-[Read more about JsonPath](jsonpath/index.md)
-[Read more about JsonPath syntax](jsonpath/jsonpath-syntax.md)
+[Read more about JsonPath](https://stillpoint-software.github.io/hyperbee.json/jsonpath/jsonpath.html)
 
 ## JSONPointer
 
 JSONPointer is a syntax for identifying a specific value within a JSON document. It is simple and easy to use, making it an excellent 
 choice for pinpointing exact values. Hyperbee.Json's JsonPointer implementation adheres to [RFC 6901](https://www.rfc-editor.org/rfc/rfc6901.html).
 
-[Documentation for JsonPointer coming soon]
+[Read more about JsonPointer](https://stillpoint-software.github.io/hyperbee.json/jsonpointer.html)
 
 ## JSONPatch
 
 JSONPatch is a format for describing changes to a JSON document. It allows you to apply partial modifications to JSON data efficiently. 
 Hyperbee.Json supports JsonPatch as defined in [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902.html), ensuring compatibility and reliability.
 
-[Read more about JsonPatch](jsonpatch.md)
+[Read more about JsonPatch](https://stillpoint-software.github.io/hyperbee.json/jsonpatch.html)
 
 ## JSONDiff
 
 JSONDiff allows you to compute the difference between two JSON documents, which is useful for versioning and synchronization. 
 Hyperbee.Json's implementation is optimized for performance and low memory usage, adhering to the standards set in [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902.html).
 
-[Read more about JsonDiff](jsonpatch.md)
+[Read more about JsonDiff](https://stillpoint-software.github.io/hyperbee.json/jsonpatch.html#jsondiff)
 
 ## Getting Started
 
@@ -54,10 +53,6 @@ Install via NuGet:
 dotnet add package Hyperbee.Json
 ```
 
-## Documentation
-
-Documentation can be found in the project's `/docs` folder.
-
 ## Benchmarks
 
 Here is a performance comparison of various queries on the standard book store document.

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,10 +1,18 @@
 title: Hyperbee Json
 description: Documentation for Hyperbee Json.
 remote_theme: pmarsceill/just-the-docs
+baseurl: "/hyperbee.json/" 
+url: "https://stillpoint-software.github.io"
 
 aux_links:
   "GitHub Repository":
     - "//github.com/Stillpoint-Software/hyperbee.json"
 
 # logo: "/assets/icon.png"
 search_enabled: true # Enable search
+
+# External navigation links
+nav_external_links:
+  - title: Stillpoint Software
+    url: https://www.stillpointsoftware.net/
+    opens_in_new_tab: true
diff --git a/docs/docs.projitems b/docs/docs.projitems
@@ -12,9 +12,12 @@
     <None Include="$(MSBuildThisFileDirectory)additional-classes.md" />
     <None Include="$(MSBuildThisFileDirectory)index.md" />
     <None Include="$(MSBuildThisFileDirectory)jsonpatch.md" />
+    <None Include="$(MSBuildThisFileDirectory)jsonpath\comparison.md" />
     <None Include="$(MSBuildThisFileDirectory)jsonpath\functions.md" />
-    <None Include="$(MSBuildThisFileDirectory)jsonpath\index.md" />
+    <None Include="$(MSBuildThisFileDirectory)jsonpath\jsonpath.md" />
+    <None Include="$(MSBuildThisFileDirectory)jsonpath\overview.md" />
     <None Include="$(MSBuildThisFileDirectory)jsonpath\syntax.md" />
     <None Include="$(MSBuildThisFileDirectory)jsonpointer.md" />
+    <None Include="$(MSBuildThisFileDirectory)_config.yml" />
   </ItemGroup>
 </Project>
diff --git a/docs/index.md b/docs/index.md
@@ -26,29 +26,28 @@ JSONPath is a query language for JSON, allowing you to navigate and extract data
 Hyperbee.Json's JSONPath implementation is designed for optimal performance, ensuring low memory allocations and fast query execution. 
 It fully conforms to [RFC 9535](https://www.rfc-editor.org/rfc/rfc9535.html).
 
-[Read more about JsonPath](jsonpath/index.md)
-[Read more about JsonPath syntax](jsonpath/jsonpath-syntax.md)
+[Read more about JsonPath]({{ site.url }}{{ site.baseurl }}jsonpath/jsonpath.html)
 
 ## JSONPointer
 
 JSONPointer is a syntax for identifying a specific value within a JSON document. It is simple and easy to use, making it an excellent 
 choice for pinpointing exact values. Hyperbee.Json's JsonPointer implementation adheres to [RFC 6901](https://www.rfc-editor.org/rfc/rfc6901.html).
 
-[Documentation for JsonPointer coming soon]
+[Read more about JsonPointer]({{ site.url }}{{ site.baseurl }}jsonpointer.html)
 
 ## JSONPatch
 
 JSONPatch is a format for describing changes to a JSON document. It allows you to apply partial modifications to JSON data efficiently. 
 Hyperbee.Json supports JsonPatch as defined in [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902.html), ensuring compatibility and reliability.
 
-[Read more about JsonPatch](jsonpatch.md)
+[Read more about JsonPatch]({{ site.url }}{{ site.baseurl }}jsonpatch.html)
 
 ## JSONDiff
 
 JSONDiff allows you to compute the difference between two JSON documents, which is useful for versioning and synchronization. 
 Hyperbee.Json's implementation is optimized for performance and low memory usage, adhering to the standards set in [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902.html).
 
-[Read more about JsonDiff](jsonpatch.md)
+[Read more about JsonDiff]({{ site.url }}{{ site.baseurl }}jsonpatch.html#jsondiff)
 
 ## Getting Started
 
@@ -60,10 +59,6 @@ Install via NuGet:
 dotnet add package Hyperbee.Json
 ```
 
-## Additional Documentation
-
-Additional documentation can be found in the project's `/docs` folder.
-
 ## Credits
 
 Hyperbee.Json is built upon the great work of several open-source projects. Special thanks to:

diff --git a/docs/jsonpatch.md b/docs/jsonpatch.md
@@ -91,7 +91,9 @@ var patch = new JsonPatch(
 );
 ```
 
-Or by using JsonDiff to generate a patch from two JSON documents.
+### JsonDiff
+
+JsonPatch `PatchOperation` can also be generated from the difference between two JSON documents.
 
 ```csharp
 var source = JsonNode.Parse(