Merge pull request #518 from wpengine/prepare-docs-for-website

chore: Prepare docs for website

Author: ahuseyn

docs/explanation/get-vs-post/index.md

@@ -3,8 +3,6 @@ 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."
 ---
 
-## Overview
-
 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.
 
 ## Context
@@ -13,7 +11,7 @@ WPGraphQL is a GraphQL API for WordPress, enabling flexible and efficient data q
 
 # Details
 
-WPGraphQL supports querying data using [the endpoint](/docs/explanation/graphql-endpoints.md) in two primary ways:
+WPGraphQL supports querying data using [the endpoint](/docs/explanation/graphql-endpoints/index.md) in two primary ways:
 
 * **GET Request with Query Parameter**: You can query WPGraphQL by appending your GraphQL query as a query parameter to the `/graphql` endpoint. This method is useful for simple queries or testing purposes.
 

docs/explanation/graphql-endpoints/index.md

@@ -3,7 +3,7 @@ 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
+## 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/index.md

@@ -3,8 +3,6 @@ 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.
 
 ## Why authentication changes in headless architectures

docs/explanation/index.md

@@ -5,7 +5,7 @@ description: "High-level conceptual guides that provide background information a
 
 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
+> [!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

docs/explanation/rendering-options/index.md

@@ -3,8 +3,6 @@ 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."
 ---
 
-## Introduction
-
 This document explores the various approaches to rendering content from a headless WordPress installation. As a front-end developer working with headless WordPress, you'll need to make important decisions about how to handle and display WordPress content in your frontend application. This guide aims to help you understand the available options, their trade-offs, and best practices.
 
 ### 1. Rendering Raw HTML Content from WordPress Classic Editor

docs/explanation/routing/index.md

@@ -3,8 +3,6 @@ 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.
 
 ## Background

docs/explanation/sitemaps/index.md

@@ -3,8 +3,6 @@ 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."
 ---
 
-## A Comprehensive Overview
-
 ## What is a Sitemap?
 A sitemap is an XML file that provides a structured list of pages on a website by helping search engines discover and crawl content more efficiently. It acts as a roadmap of your website's structure, containing important metadata about each page.
 Since WordPress 5.5, there's a built-in XML sitemap generator that:

docs/how-to/index.md

@@ -5,7 +5,7 @@ description: "Step-by-step guides for implementing specific features and achievi
 
 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
+> [!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

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

@@ -3,8 +3,6 @@ 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."
 ---
 
-## Overview
-
 You can install any HWP Toolkit plugin using Composer, which is the recommended way for modern WordPress development workflows.
 
 You can also install them manually from our [Releases](https://github.com/wpengine/hwptoolkit/releases) page.

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

@@ -3,8 +3,6 @@ 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.
 
 To benefit APQ in your headless WordPress project both your front-end and WordPress setup should support this functionality.
@@ -16,7 +14,7 @@ This guide covers how to implement APQ with Apollo Client and WPGraphQL Smart Ca
 > [!NOTE]  
 > Automatic Persisted Queries only helps you to reduce your request size. This technique don't cache the response you get from the server.
 
-## 0. Prerequisites
+## Prerequisites
 
 1. A WordPress installation with
    - [WPGraphQL plugin](https://wordpress.org/plugins/wp-graphql/)