This directory contains all project documentation organized by category. All documentation blocks, examples, and API docs are now synced with the latest code and workflow changes (as of 2025-11-14).
All documentation and wiki changes are now automatically checked for outdated references and broken links via the .github/workflows/docs-validation.yml workflow. Please ensure your updates pass these checks before merging.
For details, see docs-validation.yml.
docs/
├── community/ # Community health files
│ ├── CODE_OF_CONDUCT.md
│ ├── CONTRIBUTING.md
│ └── SECURITY.md
├── features/ # Feature documentation
│ ├── CHROME_RUNNER_FEATURE.md
│ ├── AUTOMATED_STAGING_RUNNER_FEATURE.md
│ ├── DEVELOPMENT_WORKFLOW.md
│ ├── RUNNER_SELF_TEST.md
│ ├── SECURITY_ADVISORY_WORKFLOW.md
│ └── USER_DEPLOYMENT_EXPERIENCE.md
├── releases/ # Release notes and changelogs
│ ├── CHANGELOG.md
│ ├── RELEASE_NOTES_v1.1.0.md
│ ├── RELEASE_NOTES_v1.1.1.md
│ ├── RELEASE_NOTES_v2.0.2.md
│ └── RELEASE_NOTES_v2.1.0.md
├── archive/ # Archived or deprecated documentation
│ ├── README_corrupted.md
│ └── CRITICAL_SECURITY_FIXES_2025.md
├── setup/ # Setup guides
│ └── quick-start.md
├── API.md # API reference
├── DEPLOYMENT.md # Production deployment instructions
├── SETUP_SUMMARY.md # Quick setup instructions
├── VERSION_OVERVIEW.md # Version tracking
└── README.md # This file
- Code of Conduct - Community behavior guidelines
- Contributing Guidelines - How to contribute to the project
- Security Policy - Security vulnerability reporting
- Chrome Runner Feature - Specialized Chrome runner implementation
- Automated Staging Runner - Staging runner bridge and job acceptance
- Development Workflow - Branching and PR strategy
- Runner Self-Test - Automated runner validation
- Quick Start - 5-minute monitoring setup
- Setup Guide - Full Prometheus and Grafana configuration
- Usage Guide - PromQL queries, alerts, and dashboard customization
- Metrics Reference - Complete metric definitions
- Architecture - System design and data flow
- Troubleshooting - Common issues and fixes
- Grafana Dashboard Metrics - Dashboard feature specification
- Changelog - Full release history
- Release Notes v2.2.0 - Latest release information
- Release Notes v2.1.0
- Release Notes v2.0.2
- Release Notes v1.1.1
- Release Notes v1.1.0
- Project README - Main project documentation
- Setup Guide - Quick setup instructions
- API Documentation - API reference
- Deployment Guide - Production deployment instructions
- Version Overview - Component and image versions
- Chrome Runner Architecture Enforcement - Details on amd64-only support
- All documentation must be placed in
/docs/subdirectories (never in root) - Feature specs:
/docs/features/ - Community files:
/docs/community/ - Release notes:
/docs/releases/ - Archive:
/docs/archive/ - API docs:
/docs/API.md - Main README:
/README.md(root) - Setup guides:
/docs/setup/
- Use descriptive filenames
- Follow feature or page-based naming for test and example files
- Include clear headings and navigation
- Sync documentation blocks and examples with code changes
- Document all major workflow, runner, and CI/CD improvements
- Chrome runner image only supports
linux/amd64(x86_64). Builds on ARM (Apple Silicon) will fail with a clear error.
- Automated Trivy scans for filesystem, container, and Chrome runner images
- Security scan jobs and workflow files are kept in sync across branches
- Critical security patches for prototype pollution and DoS vulnerabilities
- Optimized Docker image sizes and cache cleaning
- Enhanced Chrome Runner with latest Playwright, Cypress, and Chrome
- Standardized Docker build contexts for CI/CD
- Automated security advisory workflow
📋 Note: This structure helps maintain a clean root directory while keeping documentation organized and easily discoverable.