Skip to content

docs: Add docs to wp-admin and include Faust integration info#263

Merged
ahuseyn merged 3 commits into
mainfrom
previews-wp-admin-docs
Jun 18, 2025
Merged

docs: Add docs to wp-admin and include Faust integration info#263
ahuseyn merged 3 commits into
mainfrom
previews-wp-admin-docs

Conversation

@ahuseyn

@ahuseyn ahuseyn commented Jun 18, 2025

Copy link
Copy Markdown
Member

Description

  • Updated Readme, added new sections
  • Included Faust integration section to readme
  • Included important sections of docs to wp-admin
  • Faust documentation link is dynamic, visible when Faust is enabled

Related Issue

Dependant PRs

N/A

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?

Manual, e2e, phpstan, psalm, phpcs

Screenshots

Screenshot 2025-06-18 at 15 30 01

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

@github-actions

github-actions Bot commented Jun 18, 2025

Copy link
Copy Markdown

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

@colinmurphy colinmurphy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀 🚀 🚀

@ahuseyn ahuseyn added this pull request to the merge queue Jun 18, 2025
Merged via the queue into main with commit 2ab27d5 Jun 18, 2025
16 checks passed
@ahuseyn ahuseyn deleted the previews-wp-admin-docs branch June 18, 2025 14:15
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.

docs: Explain how to use the plugin within a Faust project docs: Add essential docs in settings page under "URL parameters"

2 participants