Skip to content

Conversation

@theodesp
Copy link
Member

Description

This PR introduces comprehensive documentation for the WPGraphQL Webhooks plugin. It includes:

  • An introductory guide covering the plugin’s purpose, features, and usage.
  • Detailed walkthroughs on creating and updating webhooks via the admin UI.
  • A new Reference section documenting all available actions and filters with descriptions and example usage.
  • A link to the documentation folder added to the main README for easy navigation.

Related Issue

  • None directly linked, but addresses the general need for better documentation and developer guidance.

Dependant PRs

  • None.

Type of Change

  • ✅ Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactoring (no functional changes)
  • 📄 Example update (no functional changes)
  • 📝 Documentation update
  • 🔍 Performance improvement
  • 🧪 Test update

How Has This Been Tested?

Documentation changes have been reviewed for clarity, accuracy, and completeness.
The examples and references have been verified against the current plugin codebase to ensure correctness.

Screenshots

N/A

Checklist

  • I have read the CONTRIBUTING document
  • My code follows the project's coding standards
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • Any dependent changes have been highlighted, merged or published

@theodesp theodesp marked this pull request as ready for review June 24, 2025 14:05
@theodesp theodesp requested a review from a team as a code owner June 24, 2025 14:05
@github-actions
Copy link

ℹ️ Download the latest wp-graphql-headless-webhooks plugin zip from this PR
(See the 'Artifacts' section at the bottom)

@github-actions
Copy link

ℹ️ Download the latest hwp-previews plugin zip from this PR
(See the 'Artifacts' section at the bottom)

@theodesp theodesp added this pull request to the merge queue Jun 25, 2025
Merged via the queue into main with commit 8bf56fd Jun 25, 2025
15 checks passed
@theodesp theodesp deleted the feature-webhooks-plugin-documentation branch June 25, 2025 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants