Documentation
README
wiki-lint: Wiki 健康检查
审查 wiki 的一致性、完整性、知识网络健康度和内容质量。
核心原则
- 源文件不可变:只能读取源文件,绝对不能修改或删除。Lint 过程中只读不写源文件。
- wiki 是复利资产:检查的不只是单个页面的质量,更要关注整个知识网络是否在不断积累和深化。
- 高效检查:不要逐个读取所有 wiki 页面。优先使用批量方式获取信息,只在需要深入检查特定页面时才单独读取。
Vault 结构
vault 根目录就是当前工作目录。源文件在子目录中(如 raw/、notes/、docs/)。 wiki 相关内容的目录结构:
wiki/— 所有 wiki 页面的根目录wiki/INDEX.md— 根索引:只列目录级概览(各目录页数 + 覆盖范围)与概述入口页,不逐页罗列wiki/<dir>/INDEX.md— 每个内容目录自己的索引,列全该目录页面及一句话摘要wiki/log.md— 操作日志(最新条目在最上面)wiki/hot.md— 近期上下文缓存wiki/meta/— 元数据目录(lint 报告等)wiki/sources/— 源文件摘要页wiki/entities/、wiki/concepts/、wiki/comparisons/、wiki/questions/等
检查方法
按以下顺序操作,尽量用最少的工具调用获取最多信息:
This is the opening of the README. Read the full README on GitHub.