[Experimental]: Documentation Testing with Playwright

[blindaa121]

Description

This PR introduces a comprehensive testing framework with Playwright for our API documentation, allowing us to automatically verify that all API documentation pages load correctly across our product ecosystem.

Motivation and Context

• Early Detection: Catch broken API documentation before it reaches production
• Complete Coverage: Test across all product categories
• Efficient Testing: Sample-based approach keeps test runs manageable
• Clear Reporting: Issues are reported by product category for easier debugging

How Has This Been Tested?

Note: Ensure local environment is running prior to the following steps

Step 1: Generate MDX Paths

First, run the collection script to scan all MDX files and generate the necessary paths:

node scripts/collect-mdx-paths.js

This will:

• Scan the products/ directory for all MDX files
• Create individual product test files in tests/products/ directory

Step 2: Run Playwright Tests

Once the test files are generated, run the Playwright tests:

yarn playwright test

or

yarn playwright test --ui (provides an intuitive testing experience)

Screenshots (if appropriate)

Playwright UI Testing Environment

Types of changes

• New feature (non-breaking change which adds functionality)

Checklist

• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes if appropriate.
• All new and existing tests passed.

[github-actions]

Visit the preview URL for this PR (updated for commit 306f88c):

https://pan-dev-f1b58--pr923-7a6y23lp.web.app

_{(expires Sun, 29 Jun 2025 00:48:08 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 9359a9fa100d5fdb082f75280473a90b1f96eb51}