更新项目 Wiki

SkillDocs & knowledge

Synchronize and update GitHub Wiki documentation during release preparation (before tagging); content must be written based on actual review of the source code.

Available today. Use it from your connected AI after setup.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the 更新项目 Wiki skill

What this skill tells your AI

The instructions your AI receives, as published by open-guji/luatex-cn in .claude/skills/update_wiki/SKILL.md and read by ahel’s review.

每次发布新版本时,需要在打 tag 之前同步更新 GitHub Wiki 文档。

在发布流程中的位置(时序很重要)

CTAN 包内嵌 文档/luatex-cn-wiki-{zh,en}.pdf,CI 在 push tag 时立即打包, 所以 Wiki 必须先于 tag 更新。完整时序见 /release_process

  1. 发布准备 PR 已创建(版本号、CHANGELOG 定版)
  2. 本技能:假定该 PR 已合并,按定稿内容更新 Wiki(Wiki 是独立仓库,直接推送)
  3. 基于新 Wiki 运行 python3 文档/build_wiki_pdf.py 生成 PDF,提交进同一个发布准备 PR
  4. 合并 PR,然后才打 tag

核心原则(必须遵守)

所有 Wiki 内容必须基于对项目代码的实际查看来编写,绝对不能凭字面理解自己编造。

在编写任何功能文档之前,必须:

  1. 先查看对应的 .sty.lua 源代码文件
  2. 确认命令的真实语法\NewDocumentCommand 定义)
  3. 确认参数的真实名称和默认值\keys_define:nn 定义)
  4. 确认命令的别名\NewCommandCopy 定义)

常用代码位置:

  • 装饰/改字/下划线:tex/decorate/luatex-cn-decorate.sty
  • 古籍命令别名:tex/guji/luatex-cn-guji.sty
  • 句读:tex/guji/luatex-cn-guji-judou.sty
  • 夹注:tex/guji/luatex-cn-guji-jiazhu.sty
  • 侧批:tex/core/luatex-cn-core-sidenote.sty
  • 眉批:tex/guji/luatex-cn-guji-meipi.sty

1. 克隆 Wiki 仓库

cd /tmp && rm -rf luatex-cn.wiki
git clone https://github.com/open-guji/luatex-cn.wiki.git

2. 检查现有 wiki 内容

克隆后先读取以下文件,检查当前状态:

  • Changelog.mdEN:Changelog.md:确认最新版本号,查看中英文是否同步(英文版可能落后)
  • Home.mdEN:Home.md:确认当前版本号

注意:英文 Changelog 有时会落后于中文版,需要补全缺失的版本条目后再添加新版本。

3. 需要更新的文件

根据发布内容,通常需要更新以下文件(中英文双语):

文件何时更新
Changelog.md / EN:Changelog.md每次发布必更新 - 添加版本条目
Home.md / EN:Home.md每次发布必更新 - 更新版本号
Correction.md / EN:Correction.md有新装饰/改字功能时
Annotation.md / EN:Annotation.md有新注释功能时(夹注、批注)
Side-Note.md / EN:Side-Note.md有侧批/眉批功能更新时
Judou.md / EN:Judou.md有句读功能更新时
Features.md / EN:Features.md有重要新功能时
Debug.md / EN:Debug.md有调试功能更新时

4. 更新流程

4.1 Changelog 更新格式

## [x.y.z] - YYYY-MM-DD

- ✨ **新功能名称**:功能描述 (fix #xx)
- 🐛 **Bug 修复**:修复内容描述 (fix #xx)
- ♻️ **代码重构**:重构内容描述

图标约定:

  • ✨ 新功能
  • 🐛 Bug 修复
  • ♻️ 重构
  • 📖 文档
  • ✅ 测试
  • 📦 打包/发布

4.2 版本号更新

在 Home.md 中找到:

> **当前版本**: [vX.Y.Z](https://github.com/open-guji/luatex-cn/releases)

更新为新版本号。

4.3 功能文档更新

对于新功能,添加:

  • 使用方法 (Usage):命令语法
  • 参数说明 (Parameters):可选参数表格
  • 示例 (Example):代码示例
  • 技术细节 (Technical Details):实现说明

5. 提交并推送

cd /tmp/luatex-cn.wiki
git add -A
git commit -m "docs: update wiki for vX.Y.Z release

- Add vX.Y.Z changelog entries (CN/EN)
- Update version to vX.Y.Z in Home pages
- [其他更新内容]

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>"

git push origin master

6. 验证

更新后在浏览器中访问 Wiki 确认:

7. 清理

rm -rf /tmp/luatex-cn.wiki

Signals

GitHub stars
105
Forks
10
Last commit
Sep 2026
Advanced
Catalog kind
skill
Gateway key
update-wiki
Source
github.com/open-guji/luatex-cn