Indexion 代码库 Wiki
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @org-eyw2ohcx/trkbt10-indexion-skills-indexion-wiki。
技能介绍
问题背景
代码库上的「知识」往往散落在 README、注释和人的脑子里。Indexion 把知识落成 .indexion/wiki/ 下受 wiki.json 清单约束的 Markdown 集合,但一页 wiki 不是单个 .md 文件:内容、清单项、检索索引(vectors.db、search-sections.json 等)与 log.json 审计记录必须一起更新。若只用编辑器改 .md,搜索仍返回旧片段、清单溯源错乱、日志缺记录——这是 Agent 维护仓库文档时最常见的踩坑。
技能如何工作
技能约定一套以 CLI 为中心的工作流。读 wiki 时先从 index.md 找分类与 hub pages(被链最多的入口页),再下钻单页。写与改 用 wiki pages add / wiki pages update,并始终带上 --sources,否则 wiki pages ingest 无法做变更检测。wiki pages update 会一次性刷新四件套;文档要求改完后应看到类似「Updated page … (search index updated)」的反馈。
变更发现 靠 wiki pages ingest:它比对 wiki.json 里列出的源码哈希与 .indexion/wiki/ingest-manifest.json,输出待办列表但不自动改写页面——由 Agent 读变更源码再 update。结构体检 用 wiki lint(断链、孤儿页、manifest 与文件不一致等);新页写完后应跑 lint 并用 ## See Also 加 wiki://page-id 互链。语义对齐 用 plan reconcile,且应以项目根 . 为 target(子目录会缩小符号集导致误报)。按报告里的 stale_doc、missing_doc、review_both 分组维护;收敛目标看 New logical reviews 是否归零。
从零规划可用 wiki pages plan(偏概念页而非单文件页);全量检索前可 wiki index build --full。log.json 记录每次 add/update/lint/ingest/index 操作,便于核对上一轮 Agent 是否做完。
边界与注意
- 反引号里的 `
wiki://...不算链接,lint 会忽略;交叉引用要用裸wiki://page-id` 或 Markdown 链接。 plan reconcile的残留候选不会永远为零:无 wiki 的模块、Type::method与裸符号名不一致、跨模块同名符号都可能长期出现,需结合 grep 与页面实际描述模块来判断。- 通过
pages update新增sources后,下一次 ingest 会把该页标为待处理——属预期,更新后再跑 ingest 固化基线即可。
使用场景
- 接手陌生仓库时,先从 index.md 的 hub 页理清架构,再按 wiki:// 链阅读相关概念页
- 上游改动导致 wiki 与源码不一致时,先 ingest 列出待更新页,再对每页执行 wiki pages update
- 合并 PR 前跑 wiki lint,修复断链、孤儿页和 manifest 与 .md 不一致等结构问题
- 大版本发布后对项目根跑 plan reconcile,按 stale_doc / missing_doc 补齐或修订页面
适合人员
- 长期在单仓内用 Agent 写文档、需要保证检索与清单跟 `.md` 同步的维护者
- 负责代码库百科/内部 wiki 质控、要在合并前用 lint 与 reconcile 报告收口的人
- 刚把 Indexion 接到项目、要从零用 wiki pages plan 规划概念页而非按文件堆页的架构记录者
- 需要根据 ingest-manifest 与 log.json 核对上一轮 Agent 是否完成 ingest/update 的 Tech Lead