|
1 | 1 | --- |
2 | 2 | layout: default |
3 | 3 | title: Documentation — WebRTC |
4 | | -description: 完整的 WebRTC 项目文档,包含技术指南、信令协议、部署说明和故障排除 |
| 4 | +description: Complete documentation for WebRTC learning platform - technical guides, signaling protocol, deployment, troubleshooting |
5 | 5 | --- |
6 | 6 |
|
7 | 7 | <div class="hero-section" style="padding: 2rem 1rem;"> |
8 | | - <h1 class="hero-title" style="font-size: 2rem;">📖 文档中心</h1> |
9 | | - <p class="hero-subtitle">探索 WebRTC 项目的完整技术文档</p> |
| 8 | + <h1 class="hero-title" style="font-size: 2rem;">📖 Documentation</h1> |
| 9 | + <p class="hero-subtitle"> |
| 10 | + <span>Complete technical documentation for WebRTC platform</span><br> |
| 11 | + <span style="font-size: 0.9rem; color: var(--color-text-light);">WebRTC 项目完整技术文档</span> |
| 12 | + </p> |
10 | 13 | </div> |
11 | 14 |
|
12 | 15 | --- |
13 | 16 |
|
14 | | -## 快速导航 |
| 17 | +## Quick Navigation |
15 | 18 |
|
16 | 19 | <div class="doc-cards"> |
17 | 20 | <a href="{{ site.baseurl }}/docs/guide" class="doc-card"> |
18 | 21 | <span class="doc-icon">🚀</span> |
19 | 22 | <div class="doc-content"> |
20 | | - <h4>快速开始指南</h4> |
21 | | - <p>环境准备、本地运行、Docker 部署的最简步骤</p> |
| 23 | + <h4>Getting Started</h4> |
| 24 | + <p>Prerequisites, local development, Docker deployment</p> |
22 | 25 | </div> |
23 | 26 | <span class="doc-arrow">→</span> |
24 | 27 | </a> |
25 | 28 |
|
26 | 29 | <a href="{{ site.baseurl }}/docs/signaling" class="doc-card"> |
27 | 30 | <span class="doc-icon">📡</span> |
28 | 31 | <div class="doc-content"> |
29 | | - <h4>信令协议参考</h4> |
30 | | - <p>WebSocket 消息格式、房间管理、心跳机制详解</p> |
| 32 | + <h4>Signaling Protocol</h4> |
| 33 | + <p>WebSocket message formats, room management, heartbeat mechanism</p> |
31 | 34 | </div> |
32 | 35 | <span class="doc-arrow">→</span> |
33 | 36 | </a> |
34 | 37 |
|
35 | 38 | <a href="{{ site.baseurl }}/docs/deployment" class="doc-card"> |
36 | 39 | <span class="doc-icon">🌐</span> |
37 | 40 | <div class="doc-content"> |
38 | | - <h4>生产部署指南</h4> |
39 | | - <p>HTTPS/WSS 配置、TURN 服务器、性能优化</p> |
| 41 | + <h4>Deployment Guide</h4> |
| 42 | + <p>HTTPS/WSS, TURN server, performance optimization</p> |
40 | 43 | </div> |
41 | 44 | <span class="doc-arrow">→</span> |
42 | 45 | </a> |
43 | 46 |
|
44 | 47 | <a href="{{ site.baseurl }}/docs/troubleshooting" class="doc-card"> |
45 | 48 | <span class="doc-icon">🔍</span> |
46 | 49 | <div class="doc-content"> |
47 | | - <h4>常见问题排查</h4> |
48 | | - <p>连接问题、媒体问题、部署问题的解决方案</p> |
| 50 | + <h4>Troubleshooting</h4> |
| 51 | + <p>Connection issues, media problems, deployment solutions</p> |
49 | 52 | </div> |
50 | 53 | <span class="doc-arrow">→</span> |
51 | 54 | </a> |
52 | 55 |
|
53 | 56 | <a href="{{ site.baseurl }}/docs/api" class="doc-card"> |
54 | 57 | <span class="doc-icon">⚙️</span> |
55 | 58 | <div class="doc-content"> |
56 | | - <h4>API 配置参考</h4> |
57 | | - <p>环境变量、端口配置、ICE 服务器配置说明</p> |
| 59 | + <h4>API Reference</h4> |
| 60 | + <p>Environment variables, ports, ICE server configuration</p> |
58 | 61 | </div> |
59 | 62 | <span class="doc-arrow">→</span> |
60 | 63 | </a> |
61 | 64 | </div> |
62 | 65 |
|
63 | 66 | --- |
64 | 67 |
|
65 | | -## 文档结构 |
| 68 | +## Documentation Structure |
66 | 69 |
|
67 | | -本项目遵循 **Spec-Driven Development (Spec-Driven Development)** 方法论,所有实现都基于规范文档。 |
| 70 | +This project follows **Spec-Driven Development (SDD)**. All implementation is driven by specifications. |
68 | 71 |
|
69 | | -### 用户与开发者指南 |
| 72 | +### User & Developer Guides |
70 | 73 |
|
71 | | -| 文档 | 中文 | 英文 | 说明 | |
72 | | -|:-----|:--:|:--:|:-----| |
73 | | -| **指南** | [中文](guide.zh-CN.md) | [English](guide.md) | 架构、实现细节、代码走读 | |
74 | | -| **部署** | [中文](deployment.zh-CN.md) | [English](deployment.md) | Docker、HTTPS/TURN 设置、生产部署 | |
75 | | -| **信令协议** | [中文](signaling.zh-CN.md) | [English](signaling.md) | WebSocket 协议和消息规范 | |
76 | | -| **API 参考** | [中文](api.zh-CN.md) | [English](api.md) | 配置选项、环境变量、端点 | |
77 | | -| **故障排除** | [中文](troubleshooting.zh-CN.md) | [English](troubleshooting.md) | 常见问题和解决方案 | |
| 74 | +| Document | EN | ZH | Description | |
| 75 | +|:---------|:--:|:--:|:------------| |
| 76 | +| **Guide** | [English](guide.md) | [中文](guide.zh-CN.md) | Architecture, implementation details, code walkthrough | |
| 77 | +| **Deployment** | [English](deployment.md) | [中文](deployment.zh-CN.md) | Docker, HTTPS/TURN setup, production deployment | |
| 78 | +| **Signaling** | [English](signaling.md) | [中文](signaling.zh-CN.md) | WebSocket protocol and message specifications | |
| 79 | +| **API Reference** | [English](api.md) | [中文](api.zh-CN.md) | Configuration options, environment variables, endpoints | |
| 80 | +| **Troubleshooting** | [English](troubleshooting.md) | [中文](troubleshooting.zh-CN.md) | Common issues and solutions | |
78 | 81 |
|
79 | | -### 规范文档 (Specs) |
| 82 | +### Specification Documents (Single Source of Truth) |
80 | 83 |
|
81 | | -规范目录是开发的**单一真相来源 (Single Source of Truth)**: |
| 84 | +The `/specs` directory is the authoritative source. **Specs drive all development.** |
82 | 85 |
|
83 | | -| 规范 | 路径 | 说明 | |
84 | | -|:-----|:-----|:-----| |
85 | | -| **产品规范** | [`/specs/product/`](../specs/product/) | 功能定义和验收标准 | |
86 | | -| **RFC 文档** | [`/specs/rfc/`](../specs/rfc/) | 技术设计文档和架构决策 | |
87 | | -| **API 规范** | [`/specs/api/`](../specs/api/) | OpenAPI 3.0 信令规范 | |
88 | | -| **数据库规范** | [`/specs/db/`](../specs/db/) | 内存数据结构定义 | |
89 | | -| **测试规范** | [`/specs/testing/`](../specs/testing/) | BDD 测试规范和验收标准 | |
| 86 | +| Spec | Path | Description | |
| 87 | +|:-----|:-----|:------------| |
| 88 | +| **Product Spec** | [`/specs/product/`](../specs/product/) | Feature definitions and acceptance criteria | |
| 89 | +| **RFC Documents** | [`/specs/rfc/`](../specs/rfc/) | Technical design and architecture decisions | |
| 90 | +| **API Spec** | [`/specs/api/`](../specs/api/) | OpenAPI 3.0 signaling specification | |
| 91 | +| **Database Spec** | [`/specs/db/`](../specs/db/) | In-memory data structure definitions | |
| 92 | +| **Testing Spec** | [`/specs/testing/`](../specs/testing/) | BDD test specifications and acceptance criteria | |
90 | 93 |
|
91 | 94 | --- |
92 | 95 |
|
93 | | -## 学习路径 |
| 96 | +## Learning Paths |
94 | 97 |
|
95 | | -### 🔰 初学者 |
| 98 | +### 🔰 Beginners |
96 | 99 |
|
97 | | -如果您是 WebRTC 新手,建议按以下顺序阅读: |
| 100 | +If you're new to WebRTC, we recommend reading in this order: |
98 | 101 |
|
99 | | -1. **[快速开始指南](guide.md#quick-start)** — 先让项目跑起来 |
100 | | -2. **[信令协议入门](signaling.md#概览)** — 了解浏览器如何建立连接 |
101 | | -3. **[技术指南 - 前端状态机](guide.md#前端状态机)** — 理解客户端如何管理连接状态 |
| 102 | +1. **[Getting Started](guide.md#quick-start)** — Get the project running |
| 103 | +2. **[Signaling Protocol Overview](signaling.md#overview)** — Understand how browsers establish connections |
| 104 | +3. **[Frontend State Machine](guide.md#frontend-state-machine)** — Understand client connection state management |
102 | 105 |
|
103 | | -### 🛠️ 开发者 |
| 106 | +### 🛠️ Developers |
104 | 107 |
|
105 | | -如果您想扩展或修改项目: |
| 108 | +If you want to extend or modify the project: |
106 | 109 |
|
107 | | -1. **[技术指南 - 架构概览](guide.md#架构概览)** — 整体系统架构 |
108 | | -2. **[RFC-0001: 信令服务器](../specs/rfc/0001-signaling-server.md)** — 服务端设计决策 |
109 | | -3. **[RFC-0002: 前端架构](../specs/rfc/0002-frontend-architecture.md)** — 客户端模块设计 |
110 | | -4. **[产品规范](../specs/product/webrtc-platform.md)** — 功能定义和验收标准 |
| 110 | +1. **[Architecture Overview](guide.md#architecture-overview)** — Overall system architecture |
| 111 | +2. **[RFC-0001: Signaling Server](../specs/rfc/0001-signaling-server.md)** — Server design decisions |
| 112 | +3. **[RFC-0002: Frontend Architecture](../specs/rfc/0002-frontend-architecture.md)** — Client module design |
| 113 | +4. **[Product Spec](../specs/product/webrtc-platform.md)** — Feature definitions and acceptance criteria |
111 | 114 |
|
112 | | -### 🏭 运维工程师 |
| 115 | +### 🏭 DevOps Engineers |
113 | 116 |
|
114 | | -如果您需要部署到生产环境: |
| 117 | +If you need to deploy to production: |
115 | 118 |
|
116 | | -1. **[部署指南](deployment.md)** — Docker 部署和配置 |
117 | | -2. **[API 配置参考](api.md#configuration)** — 所有环境变量说明 |
118 | | -3. **[故障排除](troubleshooting.md)** — 常见部署问题 |
| 119 | +1. **[Deployment Guide](deployment.md)** — Docker deployment and configuration |
| 120 | +2. **[API Configuration Reference](api.md#configuration)** — All environment variables |
| 121 | +3. **[Troubleshooting](troubleshooting.md)** — Common deployment issues |
119 | 122 |
|
120 | 123 | --- |
121 | 124 |
|
122 | | -## 相关资源 |
| 125 | +## Resources |
123 | 126 |
|
124 | | -### 外部链接 |
| 127 | +### External Links |
125 | 128 |
|
126 | | -| 资源 | 链接 | 说明 | |
127 | | -|:-----|:-----|:-----| |
128 | | -| GitHub 仓库 | [LessUp/webrtc](https://github.com/LessUp/webrtc) | 源代码、Issue、PR | |
129 | | -| 变更日志 | [CHANGELOG.md](../CHANGELOG.md) | 版本历史和发布说明 | |
130 | | -| 贡献指南 | [CONTRIBUTING.md](../CONTRIBUTING.md) | 开发流程和规范 | |
131 | | -| 路线图 | [ROADMAP.md](../ROADMAP.md) | 未来开发计划 | |
| 129 | +| Resource | Link | Description | |
| 130 | +|:---------|:-----|:------------| |
| 131 | +| GitHub Repository | [LessUp/webrtc](https://github.com/LessUp/webrtc) | Source code, Issues, PRs | |
| 132 | +| Changelog | [CHANGELOG.md](../CHANGELOG.md) | Version history and release notes | |
| 133 | +| Contributing | [CONTRIBUTING.md](../CONTRIBUTING.md) | Development workflow and guidelines | |
| 134 | +| Roadmap | [ROADMAP.md](../ROADMAP.md) | Future development plans | |
132 | 135 |
|
133 | | -### WebRTC 学习资源 |
| 136 | +### WebRTC Learning Resources |
134 | 137 |
|
135 | 138 | - [MDN - WebRTC API](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API) |
136 | | -- [WebRTC 官方文档](https://webrtc.org/getting-started/overview) |
| 139 | +- [WebRTC Official Documentation](https://webrtc.org/getting-started/overview) |
137 | 140 | - [WebRTC for the Curious](https://webrtcforthecurious.com/) |
138 | 141 |
|
139 | 142 | --- |
140 | 143 |
|
141 | 144 | <div class="callout callout-info"> |
142 | | - <div class="callout-title">💡 需要帮助?</div> |
| 145 | + <div class="callout-title">💡 Need Help?</div> |
143 | 146 | <ul style="margin-bottom: 0;"> |
144 | | - <li><strong>发现 Bug?</strong> 在 <a href="https://github.com/LessUp/webrtc/issues">GitHub Issues</a> 提交问题</li> |
145 | | - <li><strong>有功能建议?</strong> 查看 <a href="../ROADMAP.md">路线图</a> 或提交 Feature Request</li> |
146 | | - <li><strong>想参与贡献?</strong> 阅读 <a href="../CONTRIBUTING.md">贡献指南</a></li> |
| 147 | + <li><strong>Found a bug?</strong> Open an issue on <a href="https://github.com/LessUp/webrtc/issues">GitHub Issues</a></li> |
| 148 | + <li><strong>Have a feature request?</strong> Check the <a href="../ROADMAP.md">Roadmap</a> or submit a Feature Request</li> |
| 149 | + <li><strong>Want to contribute?</strong> Read the <a href="../CONTRIBUTING.md">Contributing Guidelines</a></li> |
147 | 150 | </ul> |
148 | 151 | </div> |
149 | 152 |
|
150 | 153 | --- |
151 | 154 |
|
152 | | -<div style="text-align: center; margin-top: 2rem; color: #6c757d; font-size: 0.9rem;"> |
153 | | - <strong>最后更新</strong>: 2026-04-17 | <strong>版本</strong>: v1.0.0 |
| 155 | +<div style="text-align: center; margin-top: 2rem; color: var(--color-text-light); font-size: 0.9rem;"> |
| 156 | + <strong>Last Updated / 最后更新</strong>: 2026-04-22 | <strong>Version / 版本</strong>: v1.0.0 |
154 | 157 | </div> |
0 commit comments