Merge pull request #460 from wpengine/chore-update-docs-nav.json

chore: Updated paths for toolkit nav.json  and added metadata for docs

Author: colinmurphy

docs/explanation/get-vs-post.md

@@ -1,3 +1,8 @@
+---
+title: "GET vs POST in WPGraphQL"
+description: "A guide on the differences between using a GET request with a query parameter versus a POST request to the /graphql endpoint."
+---
+
 # GET vs POST in WPGraphQL
 
 When interacting with WPGraphQL, selecting the correct HTTP method to fetch data is crucial. This guide explains the differences between using a GET request with a query parameter versus a POST request to the /graphql endpoint.

docs/explanation/graphql-endpoints.md

@@ -1,3 +1,8 @@
+---
+title: "WPGraphQL Endpoints"
+description: "A guide on the differences between using /graphql and ?graphql WPGraphQL endpoints and how to customize them."
+---
+
 # Which WPGraphQL endpoints to use: /graphql vs ?graphql
 
 WPGraphQL exposes a GraphQL endpoint that developers can use to interact with the WordPress backend and retrieve data.

docs/explanation/headless-authentication.md

@@ -1,3 +1,8 @@
+---
+title: "Headless Authentication"
+description: "A guide on the process of verifying user identity and managing access control in a decoupled architecture where the WordPress and the frontend are separate systems."
+---
+
 # What is headless authentication?
 
 Headless authentication refers to the process of verifying user identity and managing access control in a decoupled architecture where the content management system (WordPress) and the user-facing frontend are separate systems. Unlike traditional WordPress sites where authentication happens within a single application, headless authentication must work across systems, that may be located accross different regions.

docs/explanation/index.md

@@ -0,0 +1,13 @@
+---
+title: "Explanation"
+description: "High-level conceptual guides that provide background information and understanding of Headless WordPress development with the Headless WordPress Toolkit."
+---
+
+I see you found the root of the Explanatory guides! Explanatory guides are a place where we step away from code and talk high-level concepts and import background information. If you are looking to grow your understanding of Headless WordPress with the toolkit, you are in the right place.
+
+> [!note] Learn More
+> For more info on how we layout our documentation and the the role played by Explanatory Guides, please read about the [_Diátaxis_](https://diataxis.fr/explanation/) approach we use.
+
+## Contributing
+
+If you feel like something is missing or you want to add documentation, we encourage you to contribute! Please check out our [Contributing Guide](https://github.com/wpengine/hwptoolkit/blob/main/CONTRIBUTING.md) for more details.

docs/explanation/rendering-options.md

@@ -1,3 +1,8 @@
+---
+title: "Headless WordPress Rendering Options"
+description: "A guide that explores the various approaches to rendering content from a headless WordPress installation, their trade-offs, and best practices."
+---
+
 # Headless WordPress Rendering Options
 ## Introduction
 

docs/explanation/routing.md

@@ -1,3 +1,8 @@
+---
+title: "Routing in Headledd WordPress"
+description: "A guide that explores the intricacies of implementing routing in a headless WordPress setup. It covers the core challenges, possible implementations, and advanced considerations for optimizing your headless WordPress site."
+---
+
 # Routing in Headless WordPress: A Comprehensive Guide
 
 This guide explores the intricacies of implementing routing in a headless WordPress setup. We'll cover the core challenges, possible implementations, and advanced considerations for optimizing your headless WordPress site.

docs/explanation/sitemaps.md

@@ -1,3 +1,8 @@
+---
+title: "Sitemaps in Headless WordPress"
+description: "A guide on sitemaps in headless WordPress. It explains the challenges, and the different implementation approaches for sitemap generation."
+---
+
 # Sitemaps in WordPress: A Comprehensive Overview
 
 ## What is a Sitemap?

docs/how-to/index.md

@@ -0,0 +1,13 @@
+---
+title: "How-to Guides"
+description: "Step-by-step guides for implementing specific features and achieving practical goals with the Headless WordPress Toolkit."
+---
+
+I see you found the root of the How-to guides! How-to guides are a place where we walk you through implementing specific features of the Headless WordPress Toolkit. If you are looking to achieve a specific goal with the toolkit, you are in the right place.
+
+> [!note] Learn More
+> For more info on how we layout our documentation and the the role played by How-to guides, please read about the [_Diátaxis_](https://diataxis.fr/how-to-guides/) approach we use.
+
+## Contributing
+
+If you feel like something is missing or you want to add documentation, we encourage you to contribute! Please check out our [Contributing Guide](https://github.com/wpengine/hwptoolkit/blob/main/CONTRIBUTING.md) for more details.

docs/how-to/install-toolkit-plugins/index.md

@@ -1,3 +1,8 @@
+---
+title: "Installing HWP Toolkit Plugins with Composer"
+description: "A guide on how to install any HWP Toolkit plugin using Composer, which is the recommended way for modern WordPress development workflows."
+---
+
 # Installing HWP Toolkit Plugins with Composer
 
 You can install any HWP Toolkit plugin using Composer, which is the recommended way for modern WordPress development workflows.

docs/how-to/nextjs-pages-router/enable-apq/index.md

@@ -1,3 +1,8 @@
+---
+title: "Enable Automatic Persisted Queries in Next.js Pages Router"
+description: "Learn how to reduce latency and network strain in GraphQL queries using Automatic Persisted Queries (APQ) by hashing and reusing query hashes."
+---
+
 ## Overview
 
 GraphQL queries can use very detailed and long queries to get the appropriate data fields. These queries can increase the latency and put strain on the network. Automatic Persisted Queries (APQ) provides an effective solution to this issue, by hashing the queries and sending the hashes for repeated queries instead of sending the full query string.