Skip to content

Commit 36985d5

Browse files
colinmurphycolinmurphy
committed
Merge branch 'main' into wpgraphql-logging-internal-testing-448
2 parents 4ddff76 + 034247b commit 36985d5

File tree

26 files changed

+1152
-4807
lines changed

26 files changed

+1152
-4807
lines changed

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ test-results/
1616
# WordPress
1717
.wp-env
1818
.wp-env.override.json
19-
wp-env/
2019
uploads/
2120
debug.log
2221
__MACOSX

‎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/index.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Explanation"
3+
description: "High-level conceptual guides that provide background information and understanding of Headless WordPress development with the Headless WordPress Toolkit."
4+
---
5+
6+
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.
7+
8+
> [!note] Learn More
9+
> 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.
10+
11+
## Contributing
12+
13+
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‎

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/index.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "How-to Guides"
3+
description: "Step-by-step guides for implementing specific features and achieving practical goals with the Headless WordPress Toolkit."
4+
---
5+
6+
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.
7+
8+
> [!note] Learn More
9+
> 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.
10+
11+
## Contributing
12+
13+
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‎

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.

0 commit comments

Comments
 (0)