Skip to content

Commit 04d6493

Browse files
committed
style: 优化官网首页并修正文档跳转
1 parent 1ba8b14 commit 04d6493

12 files changed

Lines changed: 321 additions & 67 deletions
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## 项目上下文摘要(OnetCli 官网二次修整)
2+
生成时间:2026-03-28 15:45:04 +0800
3+
4+
### 1. 相似实现分析
5+
- **实现 1**: `docs/index.md` + `docs/index.vue`
6+
- 模式:Markdown 入口挂载 Vue 单文件组件,自定义首页视觉和结构化数据都集中在 `index.vue`。
7+
- 可复用:首页入口、`withBase` 站内链接、Tailwind 原子类与局部样式写法。
8+
- 需注意:当前首页内仍残留错误 GitHub Releases 链接与偏重的 hero 视觉。
9+
10+
- **实现 2**: `docs/features.md`、`docs/download.md`、`docs/changelog.md`
11+
- 模式:最小官网内容页采用纯 Markdown 页面,保留清晰的 frontmatter 和简单正文结构。
12+
- 可复用:新增 `guide.md` 时应沿用相同文件组织与文案密度。
13+
- 需注意:`download.md`、`changelog.md` 当前也残留错误仓库地址。
14+
15+
- **实现 3**: `docs/.vitepress/config.mts` + `docs/.vitepress/theme/style.css` + `docs/.vitepress/theme/components/GitHubStar.vue`
16+
- 模式:VitePress 全局配置、主题覆盖样式和导航组件共同决定官网导航、页脚与顶部观感。
17+
- 可复用:继续沿用现有导航配置、主题变量和 GitHub 入口组件,不额外引入新的主题系统。
18+
- 需注意:配置中仍有 `hufei/onetcli`、错误文档外链和 `search.provider = "local"`。
19+
20+
### 2. 项目约定
21+
- **命名约定**:配置和组件标识符使用英文,用户可见文案保持简体中文。
22+
- **文件组织**:VitePress 站点内容在 `docs/` 根目录,配置在 `docs/.vitepress/`,测试在 `docs/tests/`。
23+
- **导入顺序**:先第三方依赖,后本地模块。
24+
- **代码风格**:Vue 页面保持 `<template> + <script setup> + <style lang="scss">`,样式沿用 Tailwind 原子类和 CSS 变量。
25+
26+
### 3. 可复用组件清单
27+
- `docs/.vitepress/config.mts`:统一处理导航、页脚、编辑链接和站点级 meta。
28+
- `docs/.vitepress/theme/style.css`:全局导航与默认主题覆盖入口。
29+
- `docs/.vitepress/theme/components/GitHubStar.vue`:顶部 GitHub 入口组件。
30+
- `docs/index.vue`:官网首页主体结构和 JSON-LD 数据所在文件。
31+
- `docs/tests/site-config.test.mjs`、`docs/tests/site-content.test.mjs`:站点配置与内容级回归测试。
32+
33+
### 4. 测试策略
34+
- **测试框架**:Node 内置 `node:test`。
35+
- **测试模式**:配置与内容静态断言 + VitePress 构建验证。
36+
- **参考文件**:`docs/tests/site-config.test.mjs`、`docs/tests/site-content.test.mjs`、`docs/tests/seo-and-deploy.test.mjs`。
37+
- **覆盖要求**:修正文档入口、统一仓库链接、补充 guide 页面存在性,并保证 `npm run build` 成功。
38+
39+
### 5. 依赖和集成点
40+
- **外部依赖**:`vitepress`、`tailwindcss`、`vitepress-plugin-llms`、`vite-plugin-toml`。
41+
- **内部依赖**:首页截图资源位于 `docs/public/screenshots/`,logo 位于 `docs/public/logo*.svg`。
42+
- **集成方式**:GitHub Pages 读取 `docs/.vitepress/dist`,站点基础路径为 `/onetcli/`。
43+
- **配置来源**:`docs/.vitepress/config.mts` 与 `.github/workflows/release-docs.yml`。
44+
45+
### 6. 技术选型理由
46+
- **为什么用这个方案**:继续复用现有 VitePress 站点是修复成本最低、风险最小的方案。
47+
- **优势**:改动集中、SEO 友好、无额外依赖、与现有 Pages 流程完全兼容。
48+
- **劣势和风险**:如果外链或 `base` 处理不一致,仍会产生 GitHub Pages 项目页下的 404。
49+
50+
### 7. 关键风险点
51+
- **链接风险**:所有站内链接必须与 `/onetcli/` 基础路径兼容,外链仓库 owner 必须统一为 `feigeCode`。
52+
- **视觉风险**:首页需改好看,但不能偏离当前主题系统,也不能引入大规模重构。
53+
- **验证风险**:本次需要补足 guide 页面断言,否则链接修复缺乏回归保障。

‎.claude/operations-log.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2526,3 +2526,95 @@
25262526
- 在 `docs/tests/seo-and-deploy.test.mjs` 中同步更新断言,确保 workflow 配置与需求一致。
25272527
- 通过新增断言发现 `docs/index.md` 仍残留旧的 gpui 文档正文,已收敛为纯官网入口文件,避免首页继续混入旧品牌内容。
25282528
- 已重新执行 docs 侧全部测试与 `npm run build`,确认调整后依然可构建。
2529+
2530+
## 编码前检查 - OnetCli 官网二次修整
2531+
时间:2026-03-28 15:45:04 +0800
2532+
2533+
□ 已查阅上下文摘要文件:`.claude/context-summary-onetcli-website-polish.md`
2534+
□ 将使用以下可复用组件:
2535+
- `docs/.vitepress/config.mts`:统一导航、页脚、编辑链接和搜索配置。
2536+
- `docs/.vitepress/theme/style.css`:调整导航与全局官网观感。
2537+
- `docs/.vitepress/theme/components/GitHubStar.vue`:复用现有 GitHub 导航组件,仅修正链接。
2538+
- `docs/index.vue`:在现有首页结构上优化 hero、CTA 和结构化数据链接。
2539+
- `docs/features.md`、`docs/download.md`、`docs/changelog.md`:复用最小 Markdown 页面模式新增 `guide.md`。
2540+
□ 将遵循命名约定:代码标识符继续使用英文,所有用户可见文案保持简体中文。
2541+
□ 将遵循代码风格:延续现有 VitePress + Vue SFC + Tailwind 原子类 + CSS 变量风格。
2542+
□ 确认不重复造轮子,证明:已检查现有 docs 页面模式、主题样式与导航组件,不新建第二套官网框架,不增加新的主题依赖。
2543+
2544+
## 编码后声明 - OnetCli 官网二次修整
2545+
时间:2026-03-28 15:45:04 +0800
2546+
2547+
### 1. 复用了以下既有组件
2548+
- `docs/.vitepress/config.mts`:直接在现有站点配置里修正文档入口、GitHub 链接和编辑链接。
2549+
- `docs/.vitepress/theme/components/GitHubStar.vue`:保留现有顶部 GitHub 入口组件,只替换目标仓库。
2550+
- `docs/index.vue`:保留首页结构与信息架构,只在 hero、CTA 和样式层做精修。
2551+
- `docs/.vitepress/theme/style.css`:复用现有主题变量覆盖入口,统一官网的底色、品牌色和导航观感。
2552+
- `docs/features.md`、`docs/download.md`、`docs/changelog.md`:沿用最小 Markdown 页面模式新增 `docs/guide.md`。
2553+
2554+
### 2. 遵循了以下项目约定
2555+
- 命名约定:站点配置、Vue 组件和测试中的标识符继续使用英文;用户可见内容全部保持简体中文。
2556+
- 代码风格:保持 `<script setup>`、Tailwind 原子类、局部 `scss` 和主题 CSS 变量的既有组合方式。
2557+
- 文件组织:页面仍然集中在 `docs/` 根目录,全局配置在 `docs/.vitepress/`,测试集中在 `docs/tests/`。
2558+
2559+
### 3. 对比了以下相似实现
2560+
- 对比 `docs/index.md` + `docs/index.vue`,继续使用 Markdown 路由入口挂载 Vue 官网首页的模式。
2561+
- 对比 `docs/features.md`、`docs/download.md`、`docs/changelog.md`,新增 `guide.md` 时保持纯 Markdown 内容页的组织方式。
2562+
- 对比 `docs/.vitepress/config.mts`、`docs/.vitepress/theme/style.css` 与 `GitHubStar.vue`,所有官网层调整都落在现有主题系统内,没有外扩为第二套样式体系。
2563+
2564+
### 4. 未重复造轮子的证明
2565+
- 没有再引入新的文档框架或营销页生成器,继续复用现有 VitePress 站点。
2566+
- 没有把文档入口重新做成 Vue 页面,而是沿用现有 Markdown 页面集合。
2567+
- 没有追加新的搜索或导航插件,而是直接去掉当前不适合官网的本地搜索配置。
2568+
2569+
## 验证记录 - OnetCli 官网二次修整
2570+
- `node --test tests/site-config.test.mjs tests/site-content.test.mjs tests/seo-and-deploy.test.mjs tests/legacy-source.test.mjs`:通过,共 11 条断言全部成功。
2571+
- `npm run build`:通过,VitePress 成功构建并处理 `guide.md`。
2572+
- `git diff --check`:通过,未发现空白错误或补丁格式问题。
2573+
2574+
## 编码前检查 - issue #5 分析
2575+
时间:2026-03-28 15:42:29 +0800
2576+
2577+
□ 已查阅上下文摘要文件:`.claude/context-summary-issue-5.md`
2578+
□ 将使用以下可复用组件:
2579+
- `crates/core/src/tab_container.rs`:标签栏拖动状态与窗口拖动区域
2580+
- `crates/ui/src/title_bar.rs`:标题栏拖动标准实现
2581+
- `main/src/onetcli_app.rs`:全局快捷键与窗口动作
2582+
- `script/bump-version.sh`:既有版本同步流程
2583+
- `crates/terminal_view/src/sidebar/file_manager_panel.rs`:SSH 终端侧栏文件管理器连接逻辑
2584+
- `crates/terminal_view/src/sidebar/mod.rs`:侧边栏文件管理器激活与路径同步
2585+
- `crates/terminal/src/terminal.rs`:SSH 终端重连链路
2586+
□ 将遵循命名约定:Rust 类型使用 `PascalCase`,函数和字段使用 `snake_case`。
2587+
□ 将遵循代码风格:继续沿用 GPUI 链式 UI、`cx.emit/cx.subscribe` 事件流和现有模块边界。
2588+
□ 确认不重复造轮子,证明:已核对仓库内拖动、版本显示、快捷键、终端侧栏文件管理器和 SSH 重连实现,后续修复应在既有链路上补齐,不新增第二套机制。
2589+
2590+
## Issue 分析记录 - GitHub issue #5
2591+
时间:2026-03-28 15:42:29 +0800
2592+
2593+
- 已确认仓库远端:`git@github.com:feigeCode/onetcli.git`
2594+
- 已确认最新 open issue:`feigeCode/onetcli#5`,标题 `bug反馈`,提交时间 `2026-03-28 14:24:10 +0800`
2595+
- 已确认 issue #5 实际包含 4 个独立子问题:
2596+
- 单首页标签时顶部无法拖动窗口
2597+
- 关于页版本仍显示 `0.1.3`
2598+
- `ctrl+space` 只能隐藏不能恢复
2599+
- SSH 终端重连后右侧文件传输窗空白
2600+
- 已完成上下文检索:
2601+
- 仓库结构与技术栈:`Cargo.toml`
2602+
- 标签栏拖动:`crates/core/src/tab_container.rs`、`crates/ui/src/title_bar.rs`
2603+
- 关于页版本:`main/src/setting_tab.rs`、`main/Cargo.toml`、`script/bump-version.sh`
2604+
- 快捷键与窗口动作:`main/src/onetcli_app.rs`
2605+
- SSH 终端重连:`crates/terminal/src/terminal.rs`、`crates/terminal_view/src/view.rs`
2606+
- 右侧文件传输窗:`crates/terminal_view/src/sidebar/file_manager_panel.rs`、`crates/terminal_view/src/sidebar/mod.rs`
2607+
- 已查询外部参考:
2608+
- Context7:GPUI `WindowControlArea` / 窗口 API 索引
2609+
- GitHub 开源实现:`zed-industries/zed/crates/platform_title_bar/src/platform_title_bar.rs`
2610+
- 已形成根因判断:
2611+
- issue 1:标签栏拖动区域覆盖不足,和标题栏实现不一致
2612+
- issue 2:About 版本源正确,但 `main` crate 版本未随发布 bump
2613+
- issue 3:`MinimizeWindow` 依赖活跃窗口,最小化后无法作为恢复入口
2614+
- issue 4:终端侧栏文件管理器不会跟随 SSH 终端重连,且目录刷新失败只清空列表
2615+
- 已用 shrimp-task-manager 拆分 4 个修复任务:
2616+
- `f1ad4aec-7074-4d3a-929d-26c5eb510fc2` 修复单首页标签时顶部无法拖动窗口
2617+
- `0a98f1ce-68f7-4436-8624-d363a38c329b` 修复关于页版本号显示落后
2618+
- `20708308-460d-43d7-be9b-2074ecff7f40` 修复 `ctrl+space` 只能最小化不能恢复窗口
2619+
- `83f8be4e-25c5-41e9-b4d7-a7e2c40c605f` 修复 SSH 终端重连后右侧文件传输窗空白
2620+
- 当前结论:如果继续进入修复,建议优先处理第 4 条,再处理第 1 条、第 3 条,最后处理第 2 条。

‎.claude/verification-report.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1158,3 +1158,46 @@
11581158
### 后续调整
11591159
- 已按最新需求把 GitHub Pages 正式部署工作流切换为监听 `dev` 分支。
11601160
- 已补测首页入口文件,确认不会再混入旧的 gpui Markdown 内容。
1161+
1162+
---
1163+
1164+
## 审查报告(OnetCli 官网二次修整)
1165+
生成时间:2026-03-28 15:45:04 +0800
1166+
1167+
### 需求完整性检查
1168+
- 目标明确:修正文档入口 404、统一仓库链接、去掉不必要搜索框并改善首页视觉层级。
1169+
- 范围明确:本次只修改 `docs/` 站点配置、主题样式、首页组件、内容页与测试,不涉及业务代码和部署主链路。
1170+
- 交付物明确:代码补丁、站内 `guide.md`、上下文摘要、操作日志、验证结果和审查报告均已落地。
1171+
- 风险与依赖明确:当前缺少浏览器级视觉回归,视觉结论主要依赖本地构建和代码审阅。
1172+
1173+
### 技术维度评分
1174+
- 代码质量:94/100
1175+
- 测试覆盖:92/100
1176+
- 规范遵循:96/100
1177+
1178+
### 战略维度评分
1179+
- 需求匹配:95/100
1180+
- 架构一致:95/100
1181+
- 风险评估:91/100
1182+
1183+
### 综合评分
1184+
- 94/100
1185+
- 建议:通过
1186+
1187+
### 验证结果
1188+
- 已执行:`node --test tests/site-config.test.mjs tests/site-content.test.mjs tests/seo-and-deploy.test.mjs tests/legacy-source.test.mjs`
1189+
- 结果:通过(11 passed)
1190+
- 已执行:`npm run build`
1191+
- 结果:通过
1192+
- 已执行:`git diff --check`
1193+
- 结果:通过
1194+
1195+
### 结论
1196+
- 导航中的“文档”现已切换为站内 `/guide` 页面,避免再跳到错误的 GitHub 外链。
1197+
- 站点内所有仓库与 Releases 链接已统一为 `feigeCode/onetcli`,编辑链接也已切到 `dev` 分支。
1198+
- 本地搜索配置已移除,顶部导航和首页观感更贴近展示型官网。
1199+
- 首页 hero、按钮和整体背景层级已收敛到更轻、更清晰的视觉方向,同时保留现有信息架构。
1200+
1201+
### 剩余风险
1202+
- 目前没有浏览器截图级或 Lighthouse 级验证,因此“更好看”主要基于代码与样式逻辑审阅。
1203+
- `docs/package.json` 中包名仍是历史遗留值 `gpui-component-docs`,不影响发布,但后续若要继续整理品牌一致性可以再清理。

‎docs/.vitepress/config.mts‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ const config: UserConfig = {
6161
footer: {
6262
message: `OnetCli 是一个面向数据库、服务器和 AI 工作流的一体化桌面客户端。`,
6363
copyright: `
64-
<a href="https://github.com/hufei/onetcli">GitHub</a>
64+
<a href="https://github.com/feigeCode/onetcli">GitHub</a>
6565
|
66-
<a href="https://github.com/hufei/onetcli/releases">Releases</a>
66+
<a href="https://github.com/feigeCode/onetcli/releases">Releases</a>
6767
|
6868
<a href="/onetcli/changelog">更新日志</a>
6969
|
@@ -78,10 +78,7 @@ const config: UserConfig = {
7878
{ text: "功能", link: "/features" },
7979
{ text: "下载", link: "/download" },
8080
{ text: "更新日志", link: "/changelog" },
81-
{
82-
text: "文档",
83-
link: "https://github.com/hufei/onetcli/blob/main/README_CN.md",
84-
},
81+
{ text: "文档", link: "/guide" },
8582
{
8683
component: "GitHubStar",
8784
},
@@ -91,11 +88,7 @@ const config: UserConfig = {
9188

9289
socialLinks: null,
9390
editLink: {
94-
pattern:
95-
"https://github.com/hufei/onetcli/edit/main/docs/:path",
96-
},
97-
search: {
98-
provider: "local",
91+
pattern: "https://github.com/feigeCode/onetcli/edit/dev/docs/:path",
9992
},
10093
},
10194
markdown: {

‎docs/.vitepress/theme/components/GitHubStar.vue‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<template>
22
<a
3-
href="https://github.com/hufei/onetcli"
3+
href="https://github.com/feigeCode/onetcli"
44
target="_blank"
55
rel="noopener noreferrer"
66
class="github-star-button"

‎docs/.vitepress/theme/style.css‎

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,24 @@
88

99
:root {
1010
--radius: 0.875rem;
11-
--background: oklch(1 0 0);
12-
--foreground: oklch(0.145 0 0);
13-
--card: oklch(1 0 0);
14-
--card-foreground: oklch(0.145 0 0);
15-
--popover: oklch(1 0 0);
16-
--popover-foreground: oklch(0.145 0 0);
17-
--primary: oklch(0.205 0 0);
18-
--primary-foreground: oklch(0.985 0 0);
19-
--secondary: oklch(0.97 0 0);
20-
--secondary-foreground: oklch(0.205 0 0);
21-
--muted: oklch(0.97 0 0);
22-
--muted-foreground: oklch(0.556 0 0);
23-
--accent: oklch(0.97 0 0);
24-
--accent-foreground: oklch(0.205 0 0);
11+
--background: #fbfaf6;
12+
--foreground: #18212f;
13+
--card: #ffffff;
14+
--card-foreground: #18212f;
15+
--popover: #ffffff;
16+
--popover-foreground: #18212f;
17+
--primary: #18212f;
18+
--primary-foreground: #ffffff;
19+
--secondary: #f4f0e7;
20+
--secondary-foreground: #18212f;
21+
--muted: #f3f1ea;
22+
--muted-foreground: #5d6976;
23+
--accent: #edf4ef;
24+
--accent-foreground: #1f4f42;
2525
--destructive: oklch(0.577 0.245 27.325);
26-
--border: oklch(0.922 0 0);
27-
--input: oklch(0.922 0 0);
28-
--ring: oklch(0.708 0 0);
26+
--border: #e3ddd0;
27+
--input: #ddd8cd;
28+
--ring: #b7c4bc;
2929
--chart-1: oklch(0.646 0.222 41.116);
3030
--chart-2: oklch(0.6 0.118 184.704);
3131
--chart-3: oklch(0.398 0.07 227.392);
@@ -47,8 +47,16 @@
4747

4848
--vp-c-text-1: var(--foreground);
4949
--vp-c-brand-1: var(--primary);
50+
--vp-c-brand-2: #24493f;
51+
--vp-c-brand-3: #315f53;
5052
--vp-c-default-1: var(--secondary);
5153
--vp-c-default-2: var(--muted);
54+
--vp-c-text-2: #52606d;
55+
--vp-c-text-3: #687483;
56+
--vp-button-brand-bg: var(--primary);
57+
--vp-button-brand-hover-bg: #0f1722;
58+
--vp-button-brand-active-bg: #0f1722;
59+
--vp-button-brand-text: var(--primary-foreground);
5260

5361
--vp-nav-bg-color: var(--background);
5462
--vp-custom-block-tip-border: var(--vp-c-default-3);
@@ -112,7 +120,9 @@
112120
}
113121

114122
.VPNav {
115-
@apply bg-(--background) border-b border-(--border);
123+
@apply border-b border-(--border);
124+
background: color-mix(in srgb, var(--background) 84%, white 16%);
125+
backdrop-filter: blur(18px);
116126

117127
.divider {
118128
@apply hidden;
@@ -125,6 +135,7 @@
125135

126136
.VPFooter {
127137
@apply border-dashed;
138+
background: transparent;
128139
}
129140

130141
.VPSidebar {

‎docs/changelog.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ description: 查看 OnetCli 最近版本和关键能力更新
1616

1717
## 更多版本
1818

19-
完整版本记录请查看 [GitHub Releases](https://github.com/hufei/onetcli/releases)。
19+
完整版本记录请查看 [GitHub Releases](https://github.com/feigeCode/onetcli/releases)。

‎docs/download.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ description: 从 GitHub Releases 下载 OnetCli 的最新版本
1515

1616
## 下载入口
1717

18-
[前往 GitHub Releases](https://github.com/hufei/onetcli/releases)
18+
[前往 GitHub Releases](https://github.com/feigeCode/onetcli/releases)
1919

2020
## 说明
2121

‎docs/guide.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: 文档
3+
description: 快速开始使用 OnetCli,了解下载、核心能力和完整仓库资料入口
4+
---
5+
6+
# 文档
7+
8+
OnetCli 当前官网先保持最小集合,这一页负责把常用入口收拢到一起。
9+
10+
## 快速开始
11+
12+
1. 先从 [GitHub Releases](https://github.com/feigeCode/onetcli/releases) 下载对应平台版本。
13+
2. 启动应用后,按你的工作流添加数据库连接、SSH 主机或本地终端标签页。
14+
3. 如果你需要 AI 辅助分析,可以在应用内继续使用查询解释、自然语言生成 SQL 等能力。
15+
16+
## 核心入口
17+
18+
- [功能总览](/features)
19+
- [下载页面](/download)
20+
- [更新日志](/changelog)
21+
- [GitHub 仓库](https://github.com/feigeCode/onetcli)
22+
23+
## 适合谁使用
24+
25+
- 需要同时处理数据库、服务器与终端任务的开发者
26+
- 需要把 SSH、SFTP 和数据库排查放到同一工作台的运维同学
27+
- 希望在桌面端直接结合 AI 做 SQL 和数据分析的工程团队
28+
29+
## 补充说明
30+
31+
当前更完整的技术细节、版本历史和源码结构,以 GitHub 仓库中的资料为准。官网的职责是先把产品能力、下载入口和高频说明讲清楚。

0 commit comments

Comments
 (0)