Skip to content

Commit 0479e0e

Browse files
committed
Re-organising docs.
1 parent e3ee21c commit 0479e0e

File tree

2 files changed

+32
-48
lines changed

2 files changed

+32
-48
lines changed

docs/index.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,15 @@ The toolkit includes several WordPress plugins to enhance the headless experienc
1515

1616
| Plugin | Description |
1717
|--------|-------------|
18-
| [hwp-previews](../plugins/hwp-previews/) | Headless Previews solution for WordPress: fully configurable preview URLs via the settings page which is framework agnostic. |
19-
| [wpgraphql-webhooks](../plugins/wpgraphql-webhooks/) | Extends WPGraphQL to support webhook subscriptions and dispatching for headless WordPress environments. |
2018
| [wpgraphql-logging](../plugins/wpgraphql-logging/) | Logging for WPGraphQL requests with granular lifecycle events and Monolog integration. |
21-
| [wpgraphql-debug-extensions](../plugins/wpgraphql-debug-extensions/) | Advanced debugging, performance analysis, and metric collection for WPGraphQL. |
22-
23-
You can find more information about installation in the [plugins documentation](../plugins/README.md).
24-
25-
## Packages
26-
27-
We provide NPM packages that can be used in your frontend applications. All packages use vanilla ES Modules with no build step.
28-
29-
- [@wpengine/hwp-toolbar](../packages/toolbar/) — in active development (not yet published)
30-
31-
> [!NOTE]
32-
> No packages are published to npm yet. These are pre-release and subject to change.
19+
| [hwp-previews](../plugins/hwp-previews/) | Headless Previews solution for WordPress: fully configurable preview URLs via the settings page which is framework agnostic. |
3320

3421
## Examples
3522

3623
This project contains a wide variety of examples demonstrating how to use the Headless WordPress Toolkit with different frameworks like Next.js, Astro, SvelteKit, and Nuxt.
3724

3825
Most examples include a `wp-env` setup, allowing you to fully configure a headless application with a single command.
3926

40-
For a full list of examples and how to run them, please see the [examples documentation](../examples/README.md).
41-
4227
## Contributing
4328

4429
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/plugins/wpgraphql-logging/index.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -11,45 +11,14 @@ This allows users to **quickly identify** and **resolve performance issues** and
1111

1212
## Table of Contents
1313

14-
* [Project Structure](#project-structure)
1514
* [Key Features](#key-features)
1615
* [Setup](#setup)
16+
* [Project Structure](#project-structure)
1717
* [Viewing Logs](#viewing-logs)
1818
* [Uninstallation](#uninstallation)
1919
* [How to Guides](#how-to-guides)
2020
* [Contributing](#contributing)
2121

22-
## Project Structure
23-
24-
```text
25-
wpgraphql-logging/
26-
├── assets/ # Main plugin assets for CSS and JS
27-
├── src/ # Main plugin source code
28-
│ ├── Admin/ # Admin settings, menu, and settings page logic
29-
│ │ └── Settings/ # Admin settings functionality for displaying and saving data.
30-
│ ├── Events/ # Event logging, pub/sub event manager for extending the logging.
31-
│ ├── Logger/ # Logger service, Monolog handlers & processors
32-
│ │ ├── Api/ # Api interfaces for fetching and writing log data
33-
│ │ ├── Database/ # Database entity and helper
34-
│ │ ├── Handlers/ # Monolog WordPress database handler for logging data
35-
│ │ ├── Processors/ # Monolog processors for data sanitization and request headers
36-
│ │ ├── Rules/ # Rules and RuleManager to decide whether to log a query
37-
│ │ ├── Scheduler/ # Automated data cleanup and maintenance tasks
38-
│ │ └── Store/ # Log storage service
39-
│ ├── Plugin.php # Main plugin class (entry point)
40-
│ └── Autoloader.php # PSR-4 autoloader
41-
├── tests/ # All test suites
42-
│ ├── e2e/ # End-to-end tests
43-
│ └── wpunit/ # WPBrowser/Codeception unit tests
44-
├── [wpgraphql-logging.php]
45-
├── [activation.php]
46-
├── [composer.json]
47-
├── [deactivation.php]
48-
├── [CHANGELOG.md]
49-
└── [README.md]
50-
```
51-
52-
***
5322

5423
## Key Features
5524

@@ -139,6 +108,36 @@ By default the following settings are pre-configured.
139108
* `variables.email`
140109
* **Custom Rules**: Define your own sanitization rules by specifying fields to anonymize, remove, or truncate.
141110

111+
## Project Structure
112+
113+
```text
114+
wpgraphql-logging/
115+
├── assets/ # Main plugin assets for CSS and JS
116+
├── src/ # Main plugin source code
117+
│ ├── Admin/ # Admin settings, menu, and settings page logic
118+
│ │ └── Settings/ # Admin settings functionality for displaying and saving data.
119+
│ ├── Events/ # Event logging, pub/sub event manager for extending the logging.
120+
│ ├── Logger/ # Logger service, Monolog handlers & processors
121+
│ │ ├── Api/ # Api interfaces for fetching and writing log data
122+
│ │ ├── Database/ # Database entity and helper
123+
│ │ ├── Handlers/ # Monolog WordPress database handler for logging data
124+
│ │ ├── Processors/ # Monolog processors for data sanitization and request headers
125+
│ │ ├── Rules/ # Rules and RuleManager to decide whether to log a query
126+
│ │ ├── Scheduler/ # Automated data cleanup and maintenance tasks
127+
│ │ └── Store/ # Log storage service
128+
│ ├── Plugin.php # Main plugin class (entry point)
129+
│ └── Autoloader.php # PSR-4 autoloader
130+
├── tests/ # All test suites
131+
│ ├── e2e/ # End-to-end tests
132+
│ └── wpunit/ # WPBrowser/Codeception unit tests
133+
├── [wpgraphql-logging.php]
134+
├── [activation.php]
135+
├── [composer.json]
136+
├── [deactivation.php]
137+
├── [CHANGELOG.md]
138+
└── [README.md]
139+
```
140+
142141
## Viewing Logs
143142

144143
Once setup, you can view logs under GraphQL Logs -> All Logs. The admin screen is a custom implementation of the WordPress `WP_List_Table` class and provides several powerful features for managing your logs.

0 commit comments

Comments
 (0)