2.2 KiB
2.2 KiB
CONTEXT.md — github-learn
本文件是 github-learn 项目的领域词汇表(glossary only)。不含实现细节、不含规格说明。
核心术语
知识条目 (Knowledge Entry)
一个知识条目是 /knowledge-absorber 技能的单次输出结果,以 knowledge_YYYYMMDD_Title/ 命名目录,放置于 knowledge/entries/。每个条目内含一对同名的 .md(Markdown 源码)和 .html(渲染后页面)文件。
索引面板 (Index Panel)
knowledge-index.html——项目根目录下的纯静态 HTML 文件。由 scripts/update-knowledge-index.sh 生成。负责汇总所有知识条目并提供搜索和标签导航。
知识吸收器 (Knowledge Absorber)
全局 skill,位于 ~/.claude/skills/knowledge-absorber/。接收 URL 或文档,输出知识条目。
真理源 (Source of Truth)
- 日期和短标识符 (slug):由目录名
knowledge_YYYYMMDD_Slug/提取。 - 显示标题、tags、author:由 YAML frontmatter 提取。 详见 ADR-001。
短标识符 (Slug)
目录名中 YYYYMMDD_ 之后的部分。用于脚本定位目录和构建文件路径。不用于显示(显示标题来自 YAML frontmatter 的 title 字段)。
年份筛选 (Year Filter)
索引面板中的全局过滤器。年份来自知识条目的 date 字段前四位,即目录名 knowledge/entries/knowledge_YYYYMMDD_Slug/ 中的 YYYY。年份筛选与搜索、标签筛选取交集;选择“全部年份”表示不启用年份过滤。
目录约定
github-learn/
├── knowledge/
│ └── entries/
│ └── knowledge_YYYYMMDD_Title/ # 知识条目(0-N 个)
│ ├── knowledge_YYYYMMDD_Title.md
│ └── knowledge_YYYYMMDD_Title.html
├── knowledge-index.html # 索引面板(由脚本生成)
├── scripts/
│ └── update-knowledge-index.sh # 索引重建脚本
├── openspec/ # OpenSpec 当前变更和归档
├── devflow/ # 人类可读工作流档案
└── skill-workbench/ # skill 生成、历史文档和验证沙箱