如何在 docs.videowell.work 提交文章

适用：所有需提交技术文档、工作记录、产品笔记的内部成员（Aatrox / Hugh / Lris 等）

---

一、前置准备

1. 确认 Gitea 账号

docs 站点源码托管在内网 Gitea：http://192.168.1.220:3000

如果你还没有账号，联系管理员（sdwadmin）创建。

2. 找到文档仓库

仓库名：standwell/standwell-docs 地址：http://192.168.1.220:3000/standwell/standwell-docs

⚠️ 确认你有该仓库的写入权限（管理员开通）

---

二、两种提交方式

方式 A：Gitea 网页端直接编辑（推荐新手）

不需要安装任何工具，浏览器即可完成：

1. 打开仓库：http://192.168.1.220:3000/standwell/standwell-docs
2. 进入目录：点进 docs/workspace/你的用户名/ 文件夹（如 docs/workspace/aatrox/）
3. 新建文件：点右上角「➕ 新建文件」按钮
   • 文件名填写：文章标题.md（要用英文或拼音，如 em57180d-test-report.md）
   • 内容按下方模板写
4. 提交：页面底部「提交信息」写一句说明（如 "添加 EM57180D 测试报告"），点「提交变更」

方式 B：Git 命令行（适合经常写）

# 1. 克隆仓库
git clone http://192.168.1.220:3000/standwell/standwell-docs.git
cd standwell-docs

# 2. 拉取最新
git pull

# 3. 进入你的工作目录
cd docs/workspace/你的用户名/

# 4. 新建文章文件
touch 我的文章标题.md

# 5. 提交
git add 我的文章标题.md
git commit -m "添加文章：我的文章标题"
git push

⚠️ 首次 git push 会提示输入 Gitea 账号密码

---

三、文章模板

---
title: 文章标题
description: 一句话摘要（100字以内）
date: 2026-07-04
author: 你的名字
tags:
  - 标签1
  - 标签2
---

# 文章标题

## 背景

这里写为什么要写这篇文章，解决的问题是什么。

## 正文

### 小节 1

正文内容。可以包含：

- 列表项
- **加粗**、`代码` 等格式

### 小节 2

可以用表格：

| 参数 | 值 | 备注 |
|------|:--:|------|
| 型号 | EM57180D | |
| 接口 | USB 2.0 | |

## 总结

关键结论。

> 参考来源：相关规格书、测试数据

---

四、目录结构说明

docs/
├── guide/            ← 指南类文档（已有内容）
├── products/         ← 产品技术文档
│   ├── em2860/       ← 每个产品一个文件夹
│   ├── em38180/
│   └── em57180d/
├── tech/             ← 技术专题
│   ├── 工具使用/
│   ├── 故障排查/
│   └── 测试指南/
├── workspace/        ← 个人工作区（草稿/笔记）
│   ├── aatrox/
│   ├── hugh/
│   ├── lris/
│   ├── cc-1/ ~ cc-4/
│   └── videowell/
├── private/          ← 私密页面（需登录才能看）
└── public/           ← 公开素材（图片等）

建议：

• 工作笔记/草稿 → 放 workspace/你的用户名/
• 正式产品文档 → 放 products/产品名/
• 技术指南 → 放 tech/对应分类/

不确定放哪的，一律放 workspace/你的用户名/，管理员会整理归档。

---

五、提交后

代码推送到 Gitea 后，CI 会自动构建部署：

1. Gitea 检测到 main 分支有更新
2. 自动触发构建脚本
3. 约 1-2 分钟后更新到 https://docs.videowell.work/

想看到效果，直接刷新 docs 网站即可。

---

常见问题

Q：我不想把草稿公开怎么办？

放 workspace/你的用户名/ 下的内容虽然会部署到站点，但不会出现在导航栏里。只有通过直接 URL 才能访问。

如果完全不想公开，暂时先本地保存，等写完再提交。

Q：我的文件怎么在网站上访问？

URL 规则：https://docs.videowell.work/路径/文件名.html

例如 docs/workspace/hugh/test-report.md → https://docs.videowell.work/workspace/hugh/test-report.html

Q：可以用中文文件名吗？

建议用英文或拼音。中文文件名也能用，但 URL 会变成编码字符，不方便分享。

Q：提交出错了找谁？

联系 CC-1 或管理员 sdwadmin。