From a634280aa020cf9acbb99b2723875554076190f2 Mon Sep 17 00:00:00 2001 From: Colin Murphy Date: Mon, 20 Oct 2025 18:52:56 +0100 Subject: [PATCH] Update and clarify plugin and package README files Improved documentation for packages and plugins by updating status notes, badges, and descriptions. Added new plugins to the plugin list, clarified beta status, updated badge URLs, and improved links to documentation for better clarity and consistency. --- packages/README.md | 7 ++++++- plugins/README.md | 5 +++-- plugins/hwp-previews/README.md | 10 +++++----- plugins/wpgraphql-debug-extensions/README.md | 12 +++++++++++- plugins/wpgraphql-logging/README.md | 18 ++++++++++-------- 5 files changed, 35 insertions(+), 17 deletions(-) diff --git a/packages/README.md b/packages/README.md index 159bc91c..af52b69a 100644 --- a/packages/README.md +++ b/packages/README.md @@ -2,6 +2,11 @@ NPM packages for the Headless WordPress Toolkit. All packages use vanilla ES Modules with no build step. +## Status + +>[!NOTE] +>No packages are published to npm yet. These are pre-release and subject to change. + ## Packages -- `@placeholder/cli` +- [`@wpengine/hwp-toolbar`](./hwp-toolbar/README.md) — in active development (not yet published) diff --git a/plugins/README.md b/plugins/README.md index cdf4b2d2..9de9bb30 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -7,8 +7,9 @@ WordPress plugins for the Headless WordPress Toolkit. Each plugin is paired with | Plugin | Description | |--------|-------------| | [`hwp-previews`](./hwp-previews/README.md) | Headless Previews solution for WordPress: fully configurable preview URLs via the settings page which is framework agnostic. | -| [`wpgraphql-webhooks`](./wpgraphql-webhooks/README.md) | A WordPress plugin that extends [WPGraphQL](https://www.wpgraphql.com/) to support webhook subscriptions and dispatching for headless WordPress environments. This allows external applications to listen and respond to WordPress content changes through GraphQL-driven webhook events. | - +| [`wpgraphql-webhooks`](./wpgraphql-webhooks/README.md) | Extends WPGraphQL to support webhook subscriptions and dispatching for headless WordPress environments. | +| [`wpgraphql-logging`](./wpgraphql-logging/README.md) | Logging for WPGraphQL requests with granular lifecycle events and Monolog integration. | +| [`wpgraphql-debug-extensions`](./wpgraphql-debug-extensions/README.md) | Advanced debugging, performance analysis, and metric collection for WPGraphQL. | ## Install diff --git a/plugins/hwp-previews/README.md b/plugins/hwp-previews/README.md index 93d1c6bb..f992feff 100644 --- a/plugins/hwp-previews/README.md +++ b/plugins/hwp-previews/README.md @@ -8,14 +8,14 @@ ----- -[![Version](https://img.shields.io/github/v/release/wpengine/hwptoolkit?include_prereleases&label=previews&filter=%40wpengine%2Fhwp-previews-wordpress-plugin-*)](https://github.com/wpengine/hwptoolkit/releases) +[![Version](https://img.shields.io/github/v/release/wpengine/hwptoolkit?include_prereleases&label=prerelease&filter=%40wpengine%2Fhwp-previews-wordpress-plugin-*)](https://github.com/wpengine/hwptoolkit/releases) [![License](https://img.shields.io/badge/license-GPLv2%2B-green)](https://www.gnu.org/licenses/gpl-2.0.html) ![GitHub forks](https://img.shields.io/github/forks/wpengine/hwptoolkit?style=social) ![GitHub stars](https://img.shields.io/github/stars/wpengine/hwptoolkit?style=social) -[![Testing Integration](https://img.shields.io/github/check-runs/wpengine/hwptoolkit/main?checkName=hwp-previews%20codeception%20tests&label=Automated%20Tests)](https://github.com/wpengine/hwptoolkit/actions) +[![Testing Integration](https://github.com/wpengine/hwptoolkit/actions/workflows/codeception.yml/badge.svg)](https://github.com/wpengine/hwptoolkit/actions/workflows/codeception.yml) [![Code Coverage](https://img.shields.io/badge/coverage-%3E95%25-brightgreen?label=Code%20Coverage)](https://github.com/wpengine/hwptoolkit/actions) -[![Code Quality](https://img.shields.io/github/check-runs/wpengine/hwptoolkit/main?checkName=hwp-previews%20php%20code%20quality%20checks&label=Code%20Quality%20Checks)](https://github.com/wpengine/hwptoolkit/actions) -[![End-to-End Tests](https://img.shields.io/github/check-runs/wpengine/hwptoolkit/main?checkName=hwp-previews%20Playwright%20E2E%20Tests&label=End-to-End%20Tests)](https://github.com/wpengine/hwptoolkit/actions) +[![Code Quality](https://github.com/wpengine/hwptoolkit/actions/workflows/code-quality.yml/badge.svg)](https://github.com/wpengine/hwptoolkit/actions/workflows/code-quality.yml) +[![End-to-End Tests](https://github.com/wpengine/hwptoolkit/actions/workflows/e2e-test.yml/badge.svg)](https://github.com/wpengine/hwptoolkit/actions/workflows/e2e-test.yml) ----- @@ -23,7 +23,7 @@ > [!CAUTION] > This plugin is currently in a beta state. It's still under active development, so you may encounter bugs or incomplete features. Updates will be rolled out regularly. Use with caution and provide feedback if possible. You can create an issue at [https://github.com/wpengine/hwptoolkit/issues](https://github.com/wpengine/hwptoolkit/issues) ---- +----- ## Table of Contents diff --git a/plugins/wpgraphql-debug-extensions/README.md b/plugins/wpgraphql-debug-extensions/README.md index 6ca81587..4c9f465f 100644 --- a/plugins/wpgraphql-debug-extensions/README.md +++ b/plugins/wpgraphql-debug-extensions/README.md @@ -6,6 +6,16 @@ A WordPress plugin that extends [WPGraphQL](https://www.wpgraphql.com/) to provi **⚠️ Work in Progress:** This plugin is under active development and not yet production-ready. + +----- + +[![Version](https://img.shields.io/github/v/release/wpengine/hwptoolkit?include_prereleases&label=prerelease&filter=%40wpengine%2Fwpgraphql-debug-extensions-*)](https://github.com/wpengine/hwptoolkit/releases) +[![License](https://img.shields.io/badge/license-GPLv2%2B-green)](https://www.gnu.org/licenses/gpl-2.0.html) +![GitHub forks](https://img.shields.io/github/forks/wpengine/hwptoolkit?style=social) +![GitHub stars](https://img.shields.io/github/stars/wpengine/hwptoolkit?style=social) +----- + + ## Features This plugin aims to offer two primary sets of features: @@ -52,4 +62,4 @@ Clone the repository or download the latest release and place it in your WordPre For detailed usage instructions, developer references, and examples, please visit the [Documentation](docs/index.md) folder included with this plugin. ## License -BSD-0-Clause \ No newline at end of file +BSD-0-Clause diff --git a/plugins/wpgraphql-logging/README.md b/plugins/wpgraphql-logging/README.md index e915514b..6dedd132 100644 --- a/plugins/wpgraphql-logging/README.md +++ b/plugins/wpgraphql-logging/README.md @@ -2,19 +2,21 @@ A WPGraphQL logging plugin that provides visibility into request lifecycle to help quickly identify and resolve bottlenecks in your headless WordPress application. -> [!CAUTION] -> This plugin is currently in beta state and is not production ready but please feel free to test. - ----- -[![Version](https://img.shields.io/github/v/release/wpengine/hwptoolkit?include_prereleases&label=wpgraphql-logging&filter=%40wpengine%2Fwpgraphql-logging-wordpress-plugin-*)](https://github.com/wpengine/hwptoolkit/releases) +[![Version](https://img.shields.io/github/v/release/wpengine/hwptoolkit?include_prereleases&label=prerelease&filter=%40wpengine%2Fwpgraphql-logging-wordpress-plugin-*)](https://github.com/wpengine/hwptoolkit/releases) [![License](https://img.shields.io/badge/license-GPLv2%2B-green)](https://www.gnu.org/licenses/gpl-2.0.html) ![GitHub forks](https://img.shields.io/github/forks/wpengine/hwptoolkit?style=social) ![GitHub stars](https://img.shields.io/github/stars/wpengine/hwptoolkit?style=social) -[![Testing Integration](https://img.shields.io/github/check-runs/wpengine/hwptoolkit/main?checkName=wpgraphql-logging%20codeception%20tests&label=Automated%20Tests)](https://github.com/wpengine/hwptoolkit/actions) +[![Testing Integration](https://github.com/wpengine/hwptoolkit/actions/workflows/codeception.yml/badge.svg)](https://github.com/wpengine/hwptoolkit/actions/workflows/codeception.yml) [![Code Coverage](https://img.shields.io/badge/coverage-%3E90%25-brightgreen?label=Code%20Coverage)](https://github.com/wpengine/hwptoolkit/actions) -[![Code Quality](https://img.shields.io/github/check-runs/wpengine/hwptoolkit/main?checkName=wpgraphql-logging%20php%20code%20quality%20checks&label=Code%20Quality%20Checks)](https://github.com/wpengine/hwptoolkit/actions) +[![Code Quality](https://github.com/wpengine/hwptoolkit/actions/workflows/code-quality.yml/badge.svg)](https://github.com/wpengine/hwptoolkit/actions/workflows/code-quality.yml) + +----- + +> [!CAUTION] +> This plugin is currently in a beta state. It's still under active development, so you may encounter bugs or incomplete features. Updates will be rolled out regularly. Use with caution and provide feedback if possible. You can create an issue at [https://github.com/wpengine/hwptoolkit/issues](https://github.com/wpengine/hwptoolkit/issues) ----- @@ -29,7 +31,7 @@ WPGraphQL Logging is a plugin that integrates directly with the WPGraphQL Query * **Flexible Log Handling**: Leverages the powerful Monolog logging library, enabling developers to add custom processors and handlers to route logs to various destinations like Slack, files, or external services. >[!IMPORTANT] ->For detailed developer guides and examples, see our [How-To Guides](docs/index.md#how-to-guides). +>For detailed developer guides and examples, see our [How-To Guides](https://github.com/wpengine/hwptoolkit/blob/main/plugins/wpgraphql-logging/docs/index.md#how-to-guides). --- @@ -58,7 +60,7 @@ Once installed and configured, the plugin should begin to log uncached WPGraphQL ## Documentation -For detailed usage instructions, developer references, and examples, please visit the [Documentation](docs/index.md) folder included with this plugin. +For detailed usage instructions, developer references, and examples, please visit the [Documentation](https://github.com/wpengine/hwptoolkit/blob/main/plugins/wpgraphql-logging/docs/index.md) folder included with this plugin. ## License