Skip to content

Commit 53b3ff4

Browse files
author
shijiashuai
committed
docs: streamline GitHub Pages for showcase purpose
Remove Quick Start sections and code blocks from homepage. Update Hero CTA to prioritize GitHub link over Quick Start. Remove redundant "Read by goal" table from docs index. Remove inline-styled GitHub CTA block.
1 parent 9f65db0 commit 53b3ff4

5 files changed

Lines changed: 3 additions & 106 deletions

File tree

_layouts/default.html

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ <h1 class="hero-title">
9191
</div>
9292
</div>
9393
<div class="hero-actions">
94-
<a href="#quick-start" class="btn btn-primary btn-lg">
95-
<span class="btn-icon">🚀</span>
96-
Quick Start
94+
<a href="{{ site.downloads.source.url }}" class="btn btn-primary btn-lg" target="_blank" rel="noopener">
95+
<span class="btn-icon">📦</span>
96+
View on GitHub
9797
</a>
9898
{% assign docs_home_url = site.nav[1].url %}
9999
{% if page.url == '/index.zh-CN' %}
@@ -103,10 +103,6 @@ <h1 class="hero-title">
103103
<span class="btn-icon">📖</span>
104104
Documentation
105105
</a>
106-
<a href="{{ site.downloads.source.url }}" class="btn btn-ghost btn-lg" target="_blank" rel="noopener">
107-
<span class="btn-icon"></span>
108-
Star on GitHub
109-
</a>
110106
</div>
111107
<div class="hero-badges">
112108
<img src="https://github.com/LessUp/webrtc/actions/workflows/ci.yml/badge.svg" alt="CI" loading="lazy">
@@ -115,13 +111,6 @@ <h1 class="hero-title">
115111
<img src="https://img.shields.io/badge/License-MIT-00C853.svg" alt="License" loading="lazy">
116112
</div>
117113
</div>
118-
<div class="hero-scroll">
119-
<span class="scroll-indicator">
120-
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
121-
<path d="M12 5v14M19 12l-7 7-7-7" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
122-
</svg>
123-
</span>
124-
</div>
125114
</header>
126115
{% endif %}
127116

docs/index.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,6 @@ description: Documentation hub for LessUp WebRTC: architecture, signaling, deplo
66

77
# Documentation
88

9-
<div class="github-cta" style="background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); border-radius: 12px; padding: 24px; margin-bottom: 32px; color: white; text-align: center;">
10-
<h3 style="margin: 0 0 8px 0; color: white;">⭐ Like this project?</h3>
11-
<p style="margin: 0 0 16px 0; opacity: 0.9;">Star us on GitHub to show your support!</p>
12-
<a href="https://github.com/LessUp/webrtc" class="github-button" style="display: inline-block; background: white; color: #333; padding: 10px 24px; border-radius: 6px; text-decoration: none; font-weight: 600;">View on GitHub</a>
13-
</div>
14-
159
## Why LessUp WebRTC?
1610

1711
| Feature | Description |
@@ -61,17 +55,6 @@ Use this page as the public entrypoint for understanding the project.
6155
</a>
6256
</div>
6357

64-
## Read by goal
65-
66-
| Goal | Best page |
67-
|:-----|:----------|
68-
| Understand the code layout | [Technical Guide](guide) |
69-
| Integrate with the signaling server | [API Reference](api) |
70-
| Understand WebSocket message flow | [Signaling Protocol](signaling) |
71-
| Run or deploy the project | [Deployment Guide](deployment) |
72-
| Diagnose common setup issues | [Troubleshooting](troubleshooting) |
73-
| See the source-of-truth specs | [OpenSpec Hub](specs) |
74-
7558
## Public spec model
7659

7760
The repository now treats `openspec/` as the only specification authority.

docs/index.zh-CN.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,6 @@ lang: zh-CN
77

88
# 文档首页
99

10-
<div class="github-cta" style="background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); border-radius: 12px; padding: 24px; margin-bottom: 32px; color: white; text-align: center;">
11-
<h3 style="margin: 0 0 8px 0; color: white;">⭐ 喜欢这个项目?</h3>
12-
<p style="margin: 0 0 16px 0; opacity: 0.9;">在 GitHub 上给我们一个 Star 表示支持!</p>
13-
<a href="https://github.com/LessUp/webrtc" class="github-button" style="display: inline-block; background: white; color: #333; padding: 10px 24px; border-radius: 6px; text-decoration: none; font-weight: 600;">访问 GitHub</a>
14-
</div>
15-
1610
## 为什么选择 LessUp WebRTC?
1711

1812
| 特性 | 描述 |
@@ -62,17 +56,6 @@ lang: zh-CN
6256
</a>
6357
</div>
6458

65-
## 按目标阅读
66-
67-
| 目标 | 对应页面 |
68-
|:-----|:---------|
69-
| 看懂代码结构 | [技术指南](guide.zh-CN) |
70-
| 对接信令接口 | [API 参考](api.zh-CN) |
71-
| 理解 WebSocket 消息流 | [信令协议](signaling.zh-CN) |
72-
| 运行或部署项目 | [部署指南](deployment.zh-CN) |
73-
| 排查常见问题 | [故障排查](troubleshooting.zh-CN) |
74-
| 查看唯一事实来源规范 | [OpenSpec 导航](specs.zh-CN) |
75-
7659
## 公开规范模型
7760

7861
仓库现在只把 `openspec/` 视为唯一规范权威来源。

index.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -33,35 +33,6 @@ LessUp WebRTC is built for developers who want a practical reference implementat
3333
</div>
3434
</div>
3535

36-
<a id="quick-start"></a>
37-
## Quick Start
38-
39-
```bash
40-
git clone https://github.com/LessUp/webrtc.git
41-
cd webrtc
42-
go run ./cmd/server
43-
```
44-
45-
Then open `http://localhost:8080` in two browser windows and join the same room.
46-
47-
### Validation
48-
49-
```bash
50-
make check
51-
cd web && npm test
52-
```
53-
54-
## Runtime shape
55-
56-
```text
57-
cmd/server/main.go HTTP server, /ws, /healthz, /config.js
58-
internal/signal/ Hub, message handling, limits, tests
59-
web/src/core/app.js browser app entrypoint
60-
web/src/controllers/ media, peers, signaling, stats, UI
61-
openspec/specs/ repository source of truth
62-
docs/ public documentation and spec hub
63-
```
64-
6536
## Explore the project
6637

6738
<div class="doc-cards">

index.zh-CN.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -34,35 +34,6 @@ LessUp WebRTC 更像是一份可读的参考实现,而不是堆满框架和基
3434
</div>
3535
</div>
3636

37-
<a id="quick-start"></a>
38-
## 快速开始
39-
40-
```bash
41-
git clone https://github.com/LessUp/webrtc.git
42-
cd webrtc
43-
go run ./cmd/server
44-
```
45-
46-
然后在两个浏览器窗口打开 `http://localhost:8080`,加入同一个房间即可开始测试。
47-
48-
### 校验命令
49-
50-
```bash
51-
make check
52-
cd web && npm test
53-
```
54-
55-
## 运行时结构
56-
57-
```text
58-
cmd/server/main.go HTTP 服务、/ws、/healthz、/config.js
59-
internal/signal/ Hub、消息处理、限制与测试
60-
web/src/core/app.js 浏览器入口
61-
web/src/controllers/ media / peers / signaling / stats / UI
62-
openspec/specs/ 仓库唯一事实来源
63-
docs/ 公共文档与规范导航
64-
```
65-
6637
## 继续浏览
6738

6839
<div class="doc-cards">

0 commit comments

Comments
 (0)