Skip to content

chore: Tidy up examples #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open

Conversation

colinmurphy
Copy link
Member

@colinmurphy colinmurphy commented Jun 30, 2025

Description

  • Move and test examples for previews into an example subdirectory in the plugin.
  • Move and test exxmplaes for webhooks into an example subdirectory in the plugin.
  • Remove pnpm from examples and use npm.
  • Remove zip files as use an upload directory instead.
  • Test all examples
  • Update main readme file for examples
  • Add some basic guidelines for how we create an example

Related Issue

Fixes #148

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

Copy link

changeset-bot bot commented Jun 30, 2025

⚠️ No Changeset found

Latest commit: 63b7396

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

@colinmurphy colinmurphy changed the title chore: Tidy up examples chore: DRAFT Tidy up examples Jun 30, 2025
Copy link

github-actions bot commented Jun 30, 2025

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

@ahuseyn
Copy link
Member

ahuseyn commented Jul 4, 2025

@Fran-A-Dev as a part of this PR, I've been testing the examples and I had an issue with your example. It gets stuck at "Loading form..." screen, as in the screenshot. One of the issues is that the example missing the wp-env databse which should include your settings and config on WP.
Would you please take a look at this when you're available?
Screenshot 2025-07-04 at 11 50 53

@ahuseyn
Copy link
Member

ahuseyn commented Jul 8, 2025

@Fran-A-Dev as a part of this PR, I've been testing the examples and I had an issue with your example. It gets stuck at "Loading form..." screen, as in the screenshot. One of the issues is that the example missing the wp-env databse which should include your settings and config on WP. Would you please take a look at this when you're available? Screenshot 2025-07-04 at 11 50 53

@colinmurphy Created a new issue for this #328

@ahuseyn ahuseyn marked this pull request as ready for review July 8, 2025 13:16
@ahuseyn ahuseyn requested a review from a team as a code owner July 8, 2025 13:16
@colinmurphy
Copy link
Member Author

@wpengine/headless-open-source

I cannot approve this PR but for the images maybe we have a shared image folder in examples that can be re-used for all examples? Most of the examples use the same images and maybe we have one or two exceptions?

@colinmurphy colinmurphy changed the title chore: DRAFT Tidy up examples chore: Tidy up examples Jul 9, 2025
@ahuseyn
Copy link
Member

ahuseyn commented Jul 9, 2025

@wpengine/headless-open-source

I cannot approve this PR but for the images maybe we have a shared image folder in examples that can be re-used for all examples? Most of the examples use the same images and maybe we have one or two exceptions?

@colinmurphy Maybe I should bring back the .zip files.

@colinmurphy
Copy link
Member Author

@ahuseyn Not sure. Thoughts @moonmeister ? :)

@moonmeister
Copy link
Member

Yeah, we talked about it on standup. I think it's the best of the potions. Huseyn is going to look into simplifying commands.

@colinmurphy colinmurphy enabled auto-merge July 11, 2025 12:53
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.

Examples: Tidy up for WP ENV
3 participants