Skip to content

Commit bdaee09

Browse files
author
shijiashuai
committed
docs: comprehensive documentation refactor and internationalization
Major changes: - Restructure docs/ directory with bilingual support (EN/ZH) - guide.md / guide.zh-CN.md - Technical guide - deployment.md / deployment.zh-CN.md - Deployment guide - signaling.md / signaling.zh-CN.md - Protocol specification - api.md / api.zh-CN.md - API reference - troubleshooting.md / troubleshooting.zh-CN.md - Troubleshooting guide - README.md / README.zh-CN.md - Documentation index - Reorganize changelog/ with semantic versioning - 1.0.0.md - Production release - 0.9.0.md - Major refactoring - 0.8.0.md - DataChannel & Mesh - 0.1.0.md - Project infrastructure - Archive legacy date-based changelogs - Professionalize README.md and README.zh-CN.md - Add table of contents - Enhanced badges and formatting - Better navigation and structure - Update CHANGELOG.md to reference new structure Release: v1.0.0
1 parent 9bf97f8 commit bdaee09

28 files changed

Lines changed: 5788 additions & 1042 deletions

CHANGELOG.md

Lines changed: 59 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,66 @@
11
---
22
layout: default
3-
title: 变更日志 — WebRTC
4-
description: WebRTC 项目各版本变更记录
3+
title: Changelog — WebRTC
4+
description: WebRTC project version history and change records
55
---
66

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

9-
# 变更日志
9+
# Changelog
1010

11-
所有重要变更均记录在 [`changelog/`](changelog/) 目录中,按日期倒序排列。
11+
All notable changes to this project are documented in the [`changelog/`](changelog/) directory.
1212

13-
| 日期 | 摘要 |
14-
|:-----|:-----|
15-
| [2026-03-10](changelog/2026-03-10_pages-optimization.md) | Pages 工作流优化、CI badge 修正、_config.yml 清理、Pages 徽章 |
16-
| [2026-03-09](changelog/2026-03-09_pages-and-quality.md) | GitHub Pages 全面优化、golangci-lint、测试覆盖率增强、文档同步 |
17-
| [2026-03-09](changelog/2026-03-09_stability-and-security.md) | writePump 协程泄露修复、房间/人数上限、WebSocket 自动重连 |
18-
| [2026-02-13](changelog/2026-02-13.md) | 全面优化与重构(后端提取 broadcastMembers、前端重构、CI 增强、Docker) |
19-
| [2025-12-18](changelog/2025-12-18.md) | DataChannel 聊天、成员列表、Mesh 多人通话、Origin 校验、心跳 |
20-
| [2025-02-13](changelog/2025-02-13_project-infrastructure.md) | README badges 添加 |
13+
---
14+
15+
## Version History
16+
17+
| Version | Date | Description |
18+
|:--------|:-----|:------------|
19+
| [v1.0.0](changelog/1.0.0.md) | 2026-04-16 | 🎉 Production release with bilingual documentation |
20+
| [v0.9.0](changelog/0.9.0.md) | 2026-02-13 | Major refactoring, modular architecture |
21+
| [v0.8.0](changelog/0.8.0.md) | 2025-12-18 | DataChannel chat, Mesh multi-party calls |
22+
| [v0.1.0](changelog/0.1.0.md) | 2025-02-13 | Project infrastructure setup |
23+
24+
---
25+
26+
## Change Categories
27+
28+
| Category | Prefix | Description |
29+
|:---------|:-------|:------------|
30+
| Features | `feat:` | New functionality |
31+
| Fixes | `fix:` | Bug fixes |
32+
| Refactoring | `refactor:` | Code improvements |
33+
| Documentation | `docs:` | Documentation updates |
34+
| Tests | `test:` | Test additions/improvements |
35+
| Chores | `chore:` | Build, CI, tooling |
36+
| Performance | `perf:` | Performance improvements |
37+
| Security | `security:` | Security-related changes |
38+
39+
---
40+
41+
## Versioning
42+
43+
This project follows [Semantic Versioning](https://semver.org/):
44+
45+
- **MAJOR** — Incompatible API changes
46+
- **MINOR** — Backward-compatible new features
47+
- **PATCH** — Backward-compatible bug fixes
48+
49+
---
50+
51+
## Latest Highlights
52+
53+
### v1.0.0 (Current)
54+
55+
- ✅ Production-ready WebRTC learning platform
56+
- ✅ Multi-party Mesh architecture (up to 50 participants)
57+
- ✅ Bilingual documentation (English & 简体中文)
58+
- ✅ Complete API reference and troubleshooting guides
59+
- ✅ Docker deployment with HTTPS/TURN support
60+
- ✅ Comprehensive test coverage (Go + JavaScript)
61+
62+
---
63+
64+
**Full Changelog**: [`changelog/`](changelog/)
65+
66+
**Archived Logs**: [`changelog/archive/`](changelog/archive/) (legacy format)

0 commit comments

Comments
 (0)