Skip to content

Commit ab6c16b

Browse files
committed
Add frontmatter metadata to documentation guides
Introduced YAML frontmatter to multiple documentation files, specifying title and description for improved SEO and content organization. This change enhances discoverability and provides clearer context for each guide.
1 parent ad6125b commit ab6c16b

File tree

8 files changed

+40
-0
lines changed

8 files changed

+40
-0
lines changed

docs/explanation/get-vs-post.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "GET vs POST in WPGraphQL"
3+
description: "A guide on the differences between using a GET request with a query parameter versus a POST request to the /graphql endpoint."
4+
---
5+
16
# GET vs POST in WPGraphQL
27

38
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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "WPGraphQL Endpoints"
3+
description: "A guide on the differences between using /graphql and ?graphql WPGraphQL endpoints and how to customize them."
4+
---
5+
16
# Which WPGraphQL endpoints to use: /graphql vs ?graphql
27

38
WPGraphQL exposes a GraphQL endpoint that developers can use to interact with the WordPress backend and retrieve data.

docs/explanation/headless-authentication.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "Headless Authentication"
3+
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."
4+
---
5+
16
# What is headless authentication?
27

38
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/rendering-options.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "Headless WordPress Rendering Options"
3+
description: "A guide that explores the various approaches to rendering content from a headless WordPress installation, their trade-offs, and best practices."
4+
---
5+
16
# Headless WordPress Rendering Options
27
## Introduction
38

docs/explanation/routing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "Routing in Headledd WordPress"
3+
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."
4+
---
5+
16
# Routing in Headless WordPress: A Comprehensive Guide
27

38
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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "Sitemaps in Headless WordPress"
3+
description: "A guide on sitemaps in headless WordPress. It explains the challenges, and the different implementation approaches for sitemap generation."
4+
---
5+
16
# Sitemaps in WordPress: A Comprehensive Overview
27

38
## What is a Sitemap?

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "Installing HWP Toolkit Plugins with Composer"
3+
description: "A guide on how to install any HWP Toolkit plugin using Composer, which is the recommended way for modern WordPress development workflows."
4+
---
5+
16
# Installing HWP Toolkit Plugins with Composer
27

38
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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "Enable Automatic Persisted Queries in Next.js Pages Router"
3+
description: "Learn how to reduce latency and network strain in GraphQL queries using Automatic Persisted Queries (APQ) by hashing and reusing query hashes."
4+
---
5+
16
## Overview
27

38
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.

0 commit comments

Comments
 (0)