Skip to content

docs: 新增开发指南与 skills 使用指引,README 精简 - #24

Closed
SeaHi-Mo wants to merge 2 commits into
mainfrom
docs/dev-guide
Closed

SeaHi-Mo wants to merge 2 commits into
mainfrom
docs/dev-guide

Conversation

@SeaHi-Mo

Copy link
Copy Markdown
Owner

做了什么

  • 新增开发指南 /dev/(英文 /en/dev/):依赖、npm run dev/build、三套测试、目录结构、版本号五处同步与 tag 发版流程
  • 新增 skills 指引 /dev/skills:说明 skills/ 是写给 AI 助手的开发手册,三种用法(让助手读文件 / 客户端规则目录 / 常驻项目规则)、两个现有技能的适用场景、写新技能的约定
  • 快捷栏加入「开发指南」,顺序为 操作指南 | 开发指南 | 更新日志
  • README 精简:删掉环境依赖、快速开始、项目结构、当前规模与测试、技术栈、自动构建六节,改为一段「开发」指引,链接到开发指南、skills 与 AGENTS.md

为什么

README 里塞了大量构建/发版细节,普通用户看不到重点;开发相关内容移到文档站后可以分页、带侧栏和搜索,也方便后续补图。

skills 之前只在仓库里,没有对外说明;开发指南里补上了「什么时候读哪个技能」的入口。

验证

  • npm run docs:build 通过(无死链)
  • 本地预览核对:快捷栏三项、左侧「开发」分组、正文与右侧目录正常
  • README 渲染正常,链接指向 https://www.seahi-serial.c-hi.cn/dev/ 与 /dev/skills

注意

  • README 里链接的是线上域名,站点部署后才会生效;仓库内可先看 website/docs/dev/
  • 英文页为对应翻译,内容比中文略短

快捷栏
- 新增 DocsTabs:导航下方整行,操作指南 | 更新日志;桌面固定在导航下,
  窄屏收进侧栏抽屉
- 侧栏整体下移让出这一行,导航底色铺满整行、去掉半截分割线
- 搜索框紧跟标题(参考 DeepSeek 文档排布),各页位置一致

搜索
- 根 themeConfig 声明 search.provider=local 才触发索引生成(只写语言包不会生成);
  中英文各一份索引,无外部服务

更新日志
- 新增 /changelog 与 /en/changelog:构建时从 RELEASE_NOTES.md 与各 tag 的历史版本
  生成,最新在最上面,最多 12 个版本;没留存说明的版本给一行占位 + GitHub 链接
- 页面复用指南的排版(正文 60rem、右侧目录),左侧只保留「更新日志」一条
- 生成时剔除「验证 / 安装说明」这类发布流程小节

下载
- 新增 docs/.vitepress/download.ts 作为唯一来源:导航、页脚、首页按钮统一指向
  当前版本的镜像安装包,版本号取 CI 注入的 APP_VERSION
- 移除导航里重复的 GitHub 文字入口(右上角已有图标)

发布说明
- RELEASE_NOTES.md 只写功能项(新增 / 修复 / 性能 / 删除),删掉验证与安装说明小节
- 新增 /dev/ 与 /en/dev/:依赖、`npm run dev/build`、三套测试、目录结构、
  版本号五处同步与 tag 发版
- 新增 /dev/skills:说明 skills/ 是写给 AI 助手的开发手册,什么场景读哪个,
  以及写新技能的约定
- 快捷栏加入「开发指南」,位于操作指南与更新日志之间
- README 删除环境依赖 / 快速开始 / 项目结构 / 当前规模 / 技术栈 / 自动构建,
  改为指向开发指南、skills 与 AGENTS.md
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying seahi-serial-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: c666bc2
Status: ✅  Deploy successful!
Preview URL: https://bcc934c4.seahi-serial-docs.pages.dev
Branch Preview URL: https://docs-dev-guide.seahi-serial-docs.pages.dev

View logs

@SeaHi-Mo SeaHi-Mo closed this Oct 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant