Skip to content

feat: add documentation site#21

Merged
prosdev merged 1 commit into
mainfrom
feat/documentation-site
Dec 1, 2025
Merged

feat: add documentation site#21
prosdev merged 1 commit into
mainfrom
feat/documentation-site

Conversation

@prosdev
Copy link
Copy Markdown
Contributor

@prosdev prosdev commented Dec 1, 2025

Summary

Adds a Nextra 4 documentation site with Next.js 15, deployed to GitHub Pages.

What's Included

Documentation Site (website/)

  • Landing page with quick start guide and package overview
  • Getting Started guide with installation instructions
  • Core Concepts explaining annotation-driven testing
  • Annotations docs - schema, helpers, validation
  • Reporter docs - usage and configuration
  • Adapters docs - filesystem, Slack, Firestore

Features

  • Purple theme (Tailwind purple-800)
  • Static export for GitHub Pages
  • Auto-deploy workflow on push to main

GitHub Actions

  • .github/workflows/deploy-docs.yml - deploys on changes to website/

- Add Nextra 4 documentation site with Next.js 15
- Purple theme (Tailwind purple-800)
- Static export for GitHub Pages deployment
- GitHub Actions workflow for auto-deploy

Documentation includes:
- Landing page with quick start
- Getting Started guide
- Core Concepts (annotation-driven testing)
- Annotations package docs (schema, helpers, validation)
- Reporter package docs (usage, configuration)
- Adapters package docs (filesystem, slack, firestore)

Site will be available at: https://lytics.github.io/playwright-core/
@prosdev prosdev merged commit 871558e into main Dec 1, 2025
1 check passed
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.

2 participants