spike: Explore the use-cases for previews

[ahuseyn]

We need to document the common use-cases for the previews, so we can understand the potential user flows and see how the plugin behaves in those cases. The other benefits of use-cases:

• Detect the bugs in early stage
• Create documentation/tutorials for specific cases
• Have better E2E tests

NOTE: The GitHub issues of Faustjs, related to previews are a good resource to see the current bottlenecks and potential use-cases.

[ahuseyn]

Based on FE environment

• In a vanilla JS project
• In a project with FaustJS
  • With/without the Auth method of Faust
  • With/without Faust frontend URL set - fix(previews): preview doesn't work as expected when Faust configured #233
• In Next.js
  • With Next.js Draft Mode - https://github.com/wpengine/hwptoolkit/tree/main/examples/next/hwp-preview-wpgraphql
  • CSR, SSG, SSR
  • With App router
• With other major frameworks - e.g., Astro, SvelteKit, Nuxt

Based on API

• Usage with the REST API - docs(example): Add Nextjs app router example #230
• Usage with WPGraphQL

Content types and statuses

• Custom post types - ie: Preview not working for CPT in draft faustjs#1920
• Different post statuses
• Preview after changing post statuses - ie: Bug: Wordpress Private to Publish Status Change Doesnt Reflect on Frontend with Faustjs faustjs#839

Other cases

• Previews in multisite - chore: Test HWP Previews with Multisite #213
• Preview front page - Preview isn't working for frontpage faustjs#1914
• With permalink rewriting - Bug: preview not working when post permalink is rewriting faustjs#1792
• Previewing with different user roles

Showing fresh content

Previews should show fresh content each time - ie: wpengine/faustjs#1933, wpengine/faustjs#1436

Here's how this flow works:

1. Create a new page and publish it
2. Make some change but don't save and then hit the Preview button.
3. Make another change and click preview again. Do you see the latest changes?

---

These are the ones I've found. @colinmurphy if you have more in your mind, please add them as well 🙂