Skip to content

Conversation

@ahuseyn
Copy link
Member

@ahuseyn ahuseyn commented Nov 24, 2025

Description

Updates README documentation and wp-env configuration for both HWP Previews examples (REST and WPGraphQL) to improve clarity and usability.

Changes:

  • Documentation: Added frontmatter with title and description to both example readmes
  • README improvements: Reorganized installation steps, clarified instructions, and fixed typos
  • Plugin source: Updated .wp-env.json to use published plugin releases instead of local paths for better portability
  • Better structure: Improved readability with clearer section headings and step-by-step instructions

Related Issue

Dependant PRs

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?

Screenshots

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

@ahuseyn ahuseyn requested a review from a team as a code owner November 24, 2025 11:29
@changeset-bot
Copy link

changeset-bot bot commented Nov 24, 2025

⚠️ No Changeset found

Latest commit: 3838dcc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ahuseyn ahuseyn linked an issue Nov 24, 2025 that may be closed by this pull request
@github-actions
Copy link

📦 Plugin Artifacts Ready!

Download from GitHub Actions run

Available plugins:

  • ✅ hwp-previews.zip

See the "Artifacts" section at the bottom of the Actions run page

@ahuseyn ahuseyn added this pull request to the merge queue Nov 24, 2025
Merged via the queue into main with commit 776536f Nov 24, 2025
6 checks passed
@ahuseyn ahuseyn deleted the fix-hwp-previews-examples branch November 24, 2025 11:42
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.

chore(previews): Validate examples and improve scripts

3 participants