Skip to content

Commit 39c267e

Browse files
author
shijiashuai
committed
docs: improve bilingual support for documentation
- Update 404.md with English/Chinese bilingual content - Update CHANGELOG.md header with bilingual title - Update ROADMAP.md with bilingual project overview - Update docs/index.md last updated date to bilingual format
1 parent fccdda0 commit 39c267e

4 files changed

Lines changed: 108 additions & 95 deletions

File tree

404.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,35 @@
11
---
22
layout: default
3-
title: 404 — 页面未找到
4-
description: 抱歉,您访问的页面不存在
3+
title: 404 — Page Not Found
4+
description: Sorry, the page you are looking for does not exist
55
permalink: /404.html
66
---
77

88
<div class="page-404">
99
<div class="error-code">404</div>
10-
<h1 class="error-title">页面未找到</h1>
11-
<p class="error-message">抱歉,您访问的页面不存在或已被移动。</p>
12-
10+
<h1 class="error-title">Page Not Found / 页面未找到</h1>
11+
<p class="error-message">
12+
<span>Sorry, the page you are looking for does not exist or has been moved.</span><br>
13+
<span style="color: #6c757d;">抱歉,您访问的页面不存在或已被移动。</span>
14+
</p>
15+
1316
<div class="error-links">
14-
<a href="{{ site.baseurl }}/" class="btn btn-primary">🏠 返回首页</a>
15-
<a href="{{ site.baseurl }}/docs/" class="btn">📖 文档中心</a>
16-
<a href="https://github.com/LessUp/webrtc" class="btn" target="_blank" rel="noopener">⭐ GitHub 仓库</a>
17+
<a href="{{ site.baseurl }}/" class="btn btn-primary">🏠 Home / 首页</a>
18+
<a href="{{ site.baseurl }}/docs/" class="btn">📖 Documentation / 文档</a>
19+
<a href="https://github.com/LessUp/webrtc" class="btn" target="_blank" rel="noopener">⭐ GitHub</a>
1720
</div>
18-
21+
1922
<div style="margin-top: 3rem; padding: 1.5rem; background: #f8f9fa; border-radius: 8px; max-width: 500px; margin-left: auto; margin-right: auto;">
20-
<h4 style="margin-bottom: 1rem; color: #343a40;">您可能在找:</h4>
23+
<h4 style="margin-bottom: 1rem; color: #343a40;">You might be looking for / 您可能在找:</h4>
2124
<ul style="text-align: left; margin-bottom: 0;">
22-
<li><a href="{{ site.baseurl }}/docs/guide">📚 技术指南</a> — 项目整体架构和实现细节</li>
23-
<li><a href="{{ site.baseurl }}/docs/signaling">📡 信令协议</a> — WebSocket 消息格式详解</li>
24-
<li><a href="{{ site.baseurl }}/docs/deployment">🚀 部署指南</a> — Docker 部署和生产配置</li>
25-
<li><a href="{{ site.baseurl }}/CHANGELOG">📝 变更日志</a> — 版本历史和更新记录</li>
25+
<li><a href="{{ site.baseurl }}/docs/guide">📚 Technical Guide / 技术指南</a></li>
26+
<li><a href="{{ site.baseurl }}/docs/signaling">📡 Signaling Protocol / 信令协议</a></li>
27+
<li><a href="{{ site.baseurl }}/docs/deployment">🚀 Deployment Guide / 部署指南</a></li>
28+
<li><a href="{{ site.baseurl }}/CHANGELOG">📝 Changelog / 变更日志</a></li>
2629
</ul>
2730
</div>
28-
31+
2932
<p style="margin-top: 2rem; color: #6c757d; font-size: 0.9rem;">
30-
如果认为这是一个错误,请在 <a href="https://github.com/LessUp/webrtc/issues">GitHub Issues</a> 报告
33+
If you believe this is an error, please report it on <a href="https://github.com/LessUp/webrtc/issues">GitHub Issues</a>
3134
</p>
3235
</div>

CHANGELOG.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
---
22
layout: default
3-
title: 变更日志 — WebRTC
4-
description: WebRTC 项目版本历史和变更记录
3+
title: Changelog — WebRTC
4+
description: WebRTC version history and release notes - v1.0.0 production release with bilingual documentation
5+
lang: zh-CN
56
---
67

7-
[← 返回首页]({{ site.baseurl }}/)
8+
[Back to Home]({{ site.baseurl }}/) | [返回首页]({{ site.baseurl }}/)
89

9-
# 变更日志
10+
# Changelog / 变更日志
11+
12+
All notable changes are documented in the [`changelog/`](changelog/) directory. This page provides a quick overview of the version history.
1013

1114
所有重要的变更都记录在 [`changelog/`](changelog/) 目录中。本文档提供版本历史的快速概览。
1215

1316
---
1417

15-
## 版本时间线
18+
## Version Timeline / 版本时间线
1619

1720
<div class="timeline">
1821
<div class="timeline-item">

ROADMAP.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
11
---
22
layout: default
3-
title: 开发路线图 — WebRTC
4-
description: WebRTC 示例项目各阶段开发计划与进度追踪
3+
title: Roadmap — WebRTC
4+
description: WebRTC development roadmap and milestone tracking - features, phases, and future plans
55
---
66

7-
[← 返回首页]({{ site.baseurl }}/)
7+
[Back to Home]({{ site.baseurl }}/) | [返回首页]({{ site.baseurl }}/)
88

9-
# WebRTC 开发路线图
9+
# Development Roadmap / 开发路线图
1010

11-
> **项目定位**:基于 Go 的生产级 WebRTC 学习平台,从基础点对点通话到高级多人 Mesh 架构,覆盖 WebRTC 核心能力的完整实现。
11+
> **Project Positioning / 项目定位**: A production-ready WebRTC learning platform built with Go, covering everything from basic peer-to-peer calls to advanced multi-party Mesh architecture.
12+
>
13+
> 基于 Go 的生产级 WebRTC 学习平台,从基础点对点通话到高级多人 Mesh 架构,覆盖 WebRTC 核心能力的完整实现。
14+
15+
This roadmap documents the development plan, milestones, and progress tracking, designed with a progressive learning path.
1216

1317
本路线图记录项目的开发计划、里程碑和进度追踪,采用渐进式学习路径设计。
1418

1519
---
1620

17-
## 📊 项目概览
21+
## 📊 Project Overview / 项目概览
1822

19-
### 基本信息
23+
### Basic Info / 基本信息
2024

2125
| 项目 | 内容 |
2226
|:-----|:-----|
@@ -294,5 +298,5 @@ description: WebRTC 示例项目各阶段开发计划与进度追踪
294298

295299
---
296300

297-
**最后更新**2024-01-15
301+
**最后更新**2026-04-17
298302
**维护者**:LessUp Team

docs/index.md

Lines changed: 69 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,154 +1,157 @@
11
---
22
layout: default
33
title: Documentation — WebRTC
4-
description: 完整的 WebRTC 项目文档,包含技术指南、信令协议、部署说明和故障排除
4+
description: Complete documentation for WebRTC learning platform - technical guides, signaling protocol, deployment, troubleshooting
55
---
66

77
<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>
1013
</div>
1114

1215
---
1316

14-
## 快速导航
17+
## Quick Navigation
1518

1619
<div class="doc-cards">
1720
<a href="{{ site.baseurl }}/docs/guide" class="doc-card">
1821
<span class="doc-icon">🚀</span>
1922
<div class="doc-content">
20-
<h4>快速开始指南</h4>
21-
<p>环境准备、本地运行、Docker 部署的最简步骤</p>
23+
<h4>Getting Started</h4>
24+
<p>Prerequisites, local development, Docker deployment</p>
2225
</div>
2326
<span class="doc-arrow">→</span>
2427
</a>
2528

2629
<a href="{{ site.baseurl }}/docs/signaling" class="doc-card">
2730
<span class="doc-icon">📡</span>
2831
<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>
3134
</div>
3235
<span class="doc-arrow">→</span>
3336
</a>
3437

3538
<a href="{{ site.baseurl }}/docs/deployment" class="doc-card">
3639
<span class="doc-icon">🌐</span>
3740
<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>
4043
</div>
4144
<span class="doc-arrow">→</span>
4245
</a>
4346

4447
<a href="{{ site.baseurl }}/docs/troubleshooting" class="doc-card">
4548
<span class="doc-icon">🔍</span>
4649
<div class="doc-content">
47-
<h4>常见问题排查</h4>
48-
<p>连接问题、媒体问题、部署问题的解决方案</p>
50+
<h4>Troubleshooting</h4>
51+
<p>Connection issues, media problems, deployment solutions</p>
4952
</div>
5053
<span class="doc-arrow">→</span>
5154
</a>
5255

5356
<a href="{{ site.baseurl }}/docs/api" class="doc-card">
5457
<span class="doc-icon">⚙️</span>
5558
<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>
5861
</div>
5962
<span class="doc-arrow">→</span>
6063
</a>
6164
</div>
6265

6366
---
6467

65-
## 文档结构
68+
## Documentation Structure
6669

67-
本项目遵循 **Spec-Driven Development (Spec-Driven Development)** 方法论,所有实现都基于规范文档。
70+
This project follows **Spec-Driven Development (SDD)**. All implementation is driven by specifications.
6871

69-
### 用户与开发者指南
72+
### User & Developer Guides
7073

71-
| 文档 | 中文 | 英文 | 说明 |
72-
|:-----|:--:|:--:|:-----|
73-
| **指南** | [中文](guide.zh-CN.md) | [English](guide.md) | 架构、实现细节、代码走读 |
74-
| **部署** | [中文](deployment.zh-CN.md) | [English](deployment.md) | DockerHTTPS/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 |
7881

79-
### 规范文档 (Specs)
82+
### Specification Documents (Single Source of Truth)
8083

81-
规范目录是开发的**单一真相来源 (Single Source of Truth)**
84+
The `/specs` directory is the authoritative source. **Specs drive all development.**
8285

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 |
9093

9194
---
9295

93-
## 学习路径
96+
## Learning Paths
9497

95-
### 🔰 初学者
98+
### 🔰 Beginners
9699

97-
如果您是 WebRTC 新手,建议按以下顺序阅读:
100+
If you're new to WebRTC, we recommend reading in this order:
98101

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
102105

103-
### 🛠️ 开发者
106+
### 🛠️ Developers
104107

105-
如果您想扩展或修改项目:
108+
If you want to extend or modify the project:
106109

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
111114

112-
### 🏭 运维工程师
115+
### 🏭 DevOps Engineers
113116

114-
如果您需要部署到生产环境:
117+
If you need to deploy to production:
115118

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
119122

120123
---
121124

122-
## 相关资源
125+
## Resources
123126

124-
### 外部链接
127+
### External Links
125128

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 |
132135

133-
### WebRTC 学习资源
136+
### WebRTC Learning Resources
134137

135138
- [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)
137140
- [WebRTC for the Curious](https://webrtcforthecurious.com/)
138141

139142
---
140143

141144
<div class="callout callout-info">
142-
<div class="callout-title">💡 需要帮助?</div>
145+
<div class="callout-title">💡 Need Help?</div>
143146
<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>
147150
</ul>
148151
</div>
149152

150153
---
151154

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
154157
</div>

0 commit comments

Comments
 (0)