Obsidian-Knowledge-Base/AGENTS.md

AGENTS.md

基于 Obsidian 的个人 LLM Wiki。纯 Markdown — 无构建、测试、格式化、类型检查或 CI 工具链。

知识库根目录

X-Knowledge-Base/ 是 Obsidian Vault 与工作区根目录。以下所有路径均相对于它。

关键文件

文件	用途
CLAUDE.md	主要协作约定 — 工作流、命名、Frontmatter 模板
COMMIT_GUIDELINES.md	提交类型前缀定义：ingest wiki lint docs raw
wiki/index.md	全局维基入口 — 查询时始终先读这里
wiki/log.md	变更日志 — 每次 ingest/lint/wiki 操作后追加

架构（硬性规则）

• raw/ — 原始资料。导入后只读。绝不可编辑其中内容。
• wiki/ — 整理后的知识层。可自由创建、更新、合并、重构。
• 禁止将原始内容直接写入 wiki/。
• 新旧内容冲突时必须显式标注，不得静默覆盖。
• assets/ 不独立存在 — 图片等资源文件放在所属主题目录下的 assets/ 子目录中，而非顶层 assets/。如 raw/Joplin/嵌入式+Linux/assets/。

操作后必做清单

每次 ingest（导入新内容）必须：

1. 创建 wiki/source-{关键词}.md 摘要页
2. 创建或更新实体/概念/工作流页面，使用 [[wikilink]] 交叉引用
3. 更新 wiki/index.md
4. 追加 wiki/log.md

每次 query 产生可复用的稳定结论：先征求意见，再写入 wiki。

提交规则

参考 COMMIT_GUIDELINES.md，格式为 <类型>: <摘要>。本仓库使用以下类型：

类型	适用场景
ingest	导入新资料 + 同步更新 wiki
wiki	纯知识页整理（不伴随导入）
lint	知识库健康检查与修复
docs	仓库说明文档与协作规则更新
raw	仅涉及原始资料资产，暂不改 wiki

每次提交只表达一个意图，不要把导入、重构、清理混在一起。

Git 约定

• 默认分支：master
• 提交格式：<类型>: <摘要>，见上方提交规则

页面约定

• 页面命名（推荐）：小写英文 + 连字符。必要时可用拼音或中文。
• Frontmatter：见 CLAUDE.md 中各页面类型（source/entity/concept）的具体模板。

命令

无开发命令。本仓库纯 Markdown，所有工作为文件编辑、Git 提交与 Obsidian 图谱导航。

CLAUDE.md 优先级

CLAUDE.md 是详细工作流参考。本文件为快速摘要。有疑问时以 CLAUDE.md 为准。