Skip to content

docs: 将设计与验收资料迁移至 GitHub Wiki - #30

Merged
ShaoClean merged 1 commit into
developmentfrom
codex/issue-25-wiki-docs
Sep 16, 2026
Merged

ShaoClean merged 1 commit into
developmentfrom
codex/issue-25-wiki-docs

Conversation

@ShaoClean

@ShaoClean ShaoClean commented Sep 16, 2026

Copy link
Copy Markdown
Owner

背景与结果

设计和验收文档随代码提交,使截图及附件持续进入主仓库。已启用并发布 GitHub Wiki,按 Issue 组织设计、验收、功能/缺陷索引、模板和维护约定;本 PR 清理经过核对的旧副本,并更新后续贡献入口。

变更类型

  • 文档 / 测试 / 工具(docs / test / chore)

关联 Issue

Closes #25

Wiki 及既有 Issue / PR 链接独立发布;主仓库文件清理和模板更新由本 PR 合并生效。

变更内容

  • 迁移 10 份文档和 40 个图片/JSON 附件,共 4,463,189 字节。原文、历史失败及未验证项保留,仅调整链接并补充归档说明。
  • 删除 49 个已迁移完整文件;TODO.md 的项目开发计划改为 Wiki 入口,非项目内容原样保留,不迁入 Wiki。
  • README、两份贡献指南、文档目录入口和 AI 设置说明指向 Wiki;三个 Issue Forms、PR 模板增加设计链接及双向关联约定。
  • 运行、开发、发布、现行配置说明、产品图片和测试 fixtures 继续保留在代码仓库。
  • 既有相关 Issue / PR 的文档与图片链接改为 Wiki,Wiki 页面反向关联到原 Issue / PR。

设计文档(Wiki)

Issue #25 设计 · 逐文件迁移清单与验证 · 维护约定

迁移资料验证版本:Wiki commit 230161687d3d6fb2f362d639ccd2635b8191cea0;补充线上验证证据和 PR 反向链接的交付版本:ffcdcaf。Wiki 为独立仓库,资料不包含在此代码 diff 中;迁移页修订历史可查看变更。

验证

检查 / 场景 环境 结果
原文与附件完整性 源提交 184210a4ebb0a5c41bab2889bb9528ba42a9ace5 10 份文档正文核对;40 个附件逐字节及 SHA-256 一致
线上页面与附件 GitHub Wiki / raw URLs 25 个页面、41 个附件 URL(含迁移清单)全部 HTTP 200;页面标题/正文、附件 SHA-256 核对通过
页面渲染 Ego Lite / Chromium 首页分类索引和导航正常;Issue #21 验收页的 12 张内嵌图片加载正常
删除路径与保留链接 全部仍存在的 Git 跟踪文件 无删除路径残留引用;保留文档相对链接有效
GitHub 模板 js-yaml 三类表单可解析、字段 ID 唯一,均含 Wiki 字段
格式与提交 Prettier / Git hooks 新增文档入口、Issue Forms 和 PR 模板格式通过;diff、commit-msg 和 pre-push 检查通过
应用构建 / 功能测试 未运行 仅文档及模板变更,无应用代码或测试 fixture 变更

兼容性与风险

没有运行时或数据库变化。本次不重写主仓库 Git 历史,迁移不会缩小已有历史体积;控制的是当前检出与后续增长。代码 PR 不会自动回滚 Wiki,应独立核对 Wiki 修订。

早期更新验收提到的 release/update-settings.png 从未受 Git 跟踪,迁移时也不存在;目标页明确保留这一历史限制,未将它列为已迁移附件。

提交前检查

  • 已核对迁移范围、原文与附件。
  • 已记录实际验证结果及未验证项。
  • 已更新 Wiki 入口、分类索引、维护约定和 Issue / PR 双向链接。
  • 未将非项目内容扩散至 Wiki,运行与测试所需文件保留。

@ShaoClean
ShaoClean merged commit f5146e6 into development Sep 16, 2026
3 checks passed
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.

[优化] 启用 GitHub Wiki,集中维护功能与缺陷设计文档

1 participant