Skip to content

Conversation

@ahuseyn
Copy link
Member

@ahuseyn ahuseyn commented Nov 21, 2025

Description

This pull request updates the documentation links shown in the WordPress admin for the HWP Previews plugin and improves the organization of the documentation files. The main changes include updating link destinations to point to the new documentation structure and renaming the actions and filters documentation file for clarity.

Documentation improvements:

  • Updated the documentation links in the admin template (admin.php) to point to the new locations in the docs/plugins/hwp-previews directory, including new guides and tutorials.
  • Added new links for "Configure Previews", "Core Concepts", "Build Previews with Next.js and WPGraphQL", and "Build Previews with Next.js and REST API" to the admin documentation section.
  • Changed the "Actions and Filters" link in the admin to reference the renamed and relocated documentation file.

Documentation file organization:

  • Renamed ACTIONS_AND_FILTERS.md to explanation/actions-and-filters/index.md and added frontmatter for improved clarity and integration with the documentation system.
  • Updated the content and formatting of the actions and filters documentation to match the new documentation standards.

Other:

  • Added a changeset entry to document the update to documentation links on wp-admin.

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

Screenshot 2025-11-21 at 16 28 46

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 21, 2025 15:31
@changeset-bot
Copy link

changeset-bot bot commented Nov 21, 2025

🦋 Changeset detected

Latest commit: 0dff8ff

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@wpengine/hwp-previews-wordpress-plugin Patch

Not sure what this means? Click here to learn what changesets are.

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

@ahuseyn ahuseyn linked an issue Nov 21, 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 38e3e7c Nov 24, 2025
34 of 35 checks passed
@ahuseyn ahuseyn deleted the previews-update-doc-links branch November 24, 2025 09:28
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): Add references to the new docs

3 participants