Skip to content

Commit 7e404da

Browse files
author
nick
committed
Add comprehensive documentation for Claude Code + Playwright MCP YAML Testing Framework
- Created English and Chinese README files with language selection and documentation index. - Added detailed user guides covering installation, project structure, command references, YAML format, and environment configuration. - Included best practices for step library design, test case organization, tagging strategy, and environment configuration. - Documented command usage for executing tests, validating YAML, and managing reports. - Provided examples and explanations for environment variable configuration and multi-environment switching. - Structured project documentation to enhance usability and accessibility for users.
1 parent c36ded7 commit 7e404da

18 files changed

+1107
-849
lines changed

CLAUDE.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,28 @@ This project requires Playwright MCP:
4848
│ └── regression.yml # Regression test suite
4949
├── screenshots/ # Test screenshots (organized by environment)
5050
├── reports/ # Test reports (organized by environment)
51+
├── docs/ # Documentation
52+
│ ├── en/ # English documentation
53+
│ │ ├── README.md # English docs index
54+
│ │ ├── installation.md # Installation guide
55+
│ │ ├── project-structure.md # Project structure
56+
│ │ ├── commands.md # Commands reference
57+
│ │ ├── yaml-format.md # YAML format guide
58+
│ │ ├── environment-config.md # Environment configuration
59+
│ │ └── best-practices.md # Best practices
60+
│ ├── cn/ # Chinese documentation
61+
│ │ ├── README.md # Chinese docs index
62+
│ │ ├── installation.md # 安装指南
63+
│ │ ├── project-structure.md # 项目结构
64+
│ │ ├── commands.md # 命令详解
65+
│ │ ├── yaml-format.md # YAML格式说明
66+
│ │ ├── environment-config.md # 环境配置
67+
│ │ └── best-practices.md # 最佳实践
68+
│ └── README.md # Documentation index
5169
├── package.json # Node.js dependencies
5270
├── CLAUDE.md # Project description and command index
53-
└── README.md # This document
71+
├── README.md # Main README (English)
72+
└── README.cn.md # Main README (Chinese)
5473
```
5574

5675
## Features
@@ -92,12 +111,36 @@ All commands are located in the `.claude/` directory with parameter prompts:
92111
- 🌐 **Features**: Local HTTP server, auto browser opening, responsive design
93112
- 📈 **Statistics**: Environment-based report counts and statistics
94113

114+
## Documentation
115+
116+
### 📚 Complete Documentation
117+
- **[📖 Documentation Index](docs/README.md)** - Central documentation hub with language selection
118+
- **[📘 Main README (English)](README.md)** - Project overview, core concepts, and quick start
119+
- **[📘 主要说明文档 (中文)](README.cn.md)** - 项目概览、核心概念和快速开始
120+
121+
### 🇺🇸 English Documentation
122+
- **[📖 Installation Guide](docs/en/installation.md)** - Complete setup instructions
123+
- **[🏗️ Project Structure](docs/en/project-structure.md)** - Framework architecture
124+
- **[⚡ Commands Reference](docs/en/commands.md)** - All available commands
125+
- **[📝 YAML Format Guide](docs/en/yaml-format.md)** - Writing tests and step libraries
126+
- **[🔧 Environment Configuration](docs/en/environment-config.md)** - Multi-environment setup
127+
- **[✨ Best Practices](docs/en/best-practices.md)** - Testing strategies and tips
128+
129+
### 🇨🇳 中文文档
130+
- **[📖 安装指南](docs/cn/installation.md)** - 完整的安装说明
131+
- **[🏗️ 项目结构](docs/cn/project-structure.md)** - 框架架构
132+
- **[⚡ 命令详解](docs/cn/commands.md)** - 所有可用命令
133+
- **[📝 YAML格式说明](docs/cn/yaml-format.md)** - 编写测试和步骤库
134+
- **[🔧 环境配置](docs/cn/environment-config.md)** - 多环境设置
135+
- **[✨ 最佳实践](docs/cn/best-practices.md)** - 测试策略和技巧
136+
95137
## Quick Start
96138

97139
1. Install Playwright MCP
98140
2. Install Node.js dependencies: `npm install`
99141
3. Configure environment variables in `.env.*` files
100142
4. Run tests: `/run-yaml-test file:test-cases/example.yml env:dev`
143+
5. Check documentation: [docs/README.md](docs/README.md)
101144
5. Run test suites: `/run-test-suite suite:test-suites/smoke-tests.yml env:dev`
102145

103146
## YAML Test Processor

0 commit comments

Comments
 (0)