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

适用：所有需提交技术文档、产品笔记的内部成员

---

一、前置准备

1. 确认 Gitea 账号

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

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

2. 找到文档仓库

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

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

---

二、提交方式

Gitea 网页端直接编辑（推荐新手）

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

1. 打开仓库：http://192.168.1.220:3000/standwell/standwell-docs
2. 进入对应产品目录：点进 docs/products/对应产品/ 文件夹
3. 新建文件：点右上角「➕ 新建文件」按钮
   • 文件名填写英文或拼音（如 quick-start.md、driver-install.md）
   • 内容按下方模板写
4. 提交：页面底部「提交信息」写一句说明，点「提交变更」

不确定放哪个目录的，直接提交到 docs/products/ 下，管理员会整理。

---

三、文章模板

# [产品型号] — [一句话定位]

[简介：1-2句话说清这是什么、输入输出链路、核心能力]

## 能做哪些应用

| 应用 | 用到芯片/产品的能力 | 典型产品形态 |
|------|-------------------|--------------|
| 应用场景1 | 用到什么功能 | 做成什么产品 |
| 应用场景2 | 用到什么功能 | 做成什么产品 |

## 核心参数

| 参数 | 规格 |
|------|------|
| 参数1 | 值 |
| 参数2 | 值 |

## 落地指引

接线方式、驱动安装、示例代码、常见问题等。

---

四、目录结构说明

docs/
├── guide/            ← 指南类文档
├── products/         ← 产品技术文档
│   ├── em2860/       ← 每个产品一个文件夹
│   ├── em38180/
│   ├── em57180d/
│   ├── em57185d/
│   ├── em28281/
│   └── em28284/
├── private/          ← 私密页面（需登录才能看）
└── public/           ← 公开素材（图片/框图等）
    ├── diagrams/     ← 芯片框图SVG
    └── images/       ← 产品实物图

---

五、提交后

代码推送到 Gitea 后，CI 会自动构建部署，约 1-2 分钟后更新到 https://docs.videowell.work/。

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

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

例如 docs/products/em2860/quick-start.md → https://docs.videowell.work/products/em2860/quick-start.html

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

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

Q：提交出错了找谁？

联系管理员。