Skip to content

Packages and Sites ​

One body of knowledge, several outputs ​

mermaid
flowchart LR
  kn["Approved knowledge"] --> build["context build"]
  kmap["Knowledge map"] --> build
  tpl["Package templates"] --> build
  build --> kb["Knowledge package"]
  build --> site["Documentation site"]
  build --> llms["LLM Docs"]
  build --> inv["Build inventory"]

Build consumes only approved and closed knowledge. Output channels can be combined; for a new knowledge workspace the Agent proposes a knowledge package plus a website by default, and LLM text is an additional choice. Every build emits an inventory that maps distributed files back to approved knowledge in the knowledge workspace.

Agent knowledge packages ​

A knowledge package uses flat roots:

RootInternal collections
wikis/codegraph, business, product
guides/architecture, sop, faq, decision, incident
rules/standards, test
feats/feats

The default knowledge-query skill is the Agent-facing entry: it starts from directory indexes, follows edge records in the inventory, reads candidate pages and cites their headings, and reports gaps when the package does not cover a fact. When indexes do not narrow the scope, its bundled scripts/search.mjs ranks Markdown chunks locally. Consumer pages omit sources and section metadata; exact attribution stays in the workspace and is reached through the inventory.

Documentation sites ​

Enabling site on a package also produces dist/<base>-site/: a static site with article pages, local search, scripts and styles, built in a sibling staging directory so a failed site build keeps the previous output.

  • Navigation comes from the accepted src/knowledge-map.yaml. Entries bind to article identity, so labels and groups do not change URLs, and one article can appear in several places.
  • Homepage uses the first-level knowledge map as a complete site map.
  • Diagrams written in Mermaid render in the browser with the site theme and offer fit, zoom, full-screen and source controls.
  • Source footer on each article links repositories at their recorded revision and documents at their registered URL.
  • Languages can be added with site.locales; untranslated pages show the original with a notice.

Context does not deploy. Preview with any static HTTP server and deploy the contents of dist/<base>-site/ with your own hosting.

LLM Docs ​

llmsPackage() produces a text bundle for model context, offline evaluation or downstream ingestion:

text
llms.txt                   # knowledge-map index
llms-full.txt              # consolidated approved text
llms/pages/<identity>.txt  # individual articles

Customizing without forking the knowledge ​

Package templates shape distribution — extra Agent instructions, static files, query helpers — but never replace approved knowledge as the source of truth. Presentation sources for a site, such as homepage slots, custom pages and theme components, live under src/site/, separate from generated knowledge.

知识包与站点构建 ​

一套知识,多种产物 ​

mermaid
flowchart LR
  kn["已批准的知识"] --> build["context build"]
  kmap["知识地图"] --> build
  tpl["知识包模板"] --> build
  build --> kb["知识包"]
  build --> site["文档站点"]
  build --> llms["LLM Docs"]
  build --> inv["构建清单"]

构建只使用已批准且已 close 的知识。多种输出渠道可以组合;对于新的知识工作区,Agent 默认建议知识包加网站,LLM 文本是额外选项。每次构建都会产出一份清单,把分发出去的文件对应回知识工作区中已批准的知识。

Agent 知识包 ​

知识包使用扁平的根目录:

根目录内部集合
wikis/codegraph、business、product
guides/architecture、sop、faq、decision、incident
rules/standards、test
feats/feats

默认的 knowledge-query 技能是面向 Agent 的入口:它从目录索引开始,沿清单中的关系记录查找,阅读候选页面并引用其标题;当知识包没有覆盖某个事实时,会报告缺口。如果索引无法缩小范围,它会用自带的 scripts/search.mjs 在本地对 Markdown 分块排序。面向使用者的页面不包含 sources 和章节元数据;精确的出处保留在知识工作区中,可通过清单找到。

文档站点 ​

在知识包上启用 site 后,还会生成 dist/<base>-site/:一个包含文章页面、本地搜索、脚本和样式的静态站点。它在相邻的临时目录中构建,因此站点构建失败时会保留上一次的产物。

  • 导航来自已接受的 src/knowledge-map.yaml。条目绑定到文章身份,因此修改标签和分组不会改变 URL,同一篇文章也可以出现在多个位置。
  • 首页把第一级知识地图作为完整的站点地图。
  • 图表用 Mermaid 编写,在浏览器中按站点主题渲染,并提供适应窗口、缩放、全屏和查看源码等控件。
  • 来源页脚位于每篇文章底部,仓库链接到记录的修订版本,文档链接到登记的 URL。
  • 多语言可通过 site.locales 添加;未翻译的页面显示原文并附带提示。

Context 不负责部署。可以用任意静态 HTTP 服务器预览,再用你自己的托管服务部署 dist/<base>-site/ 中的内容。

LLM Docs ​

llmsPackage() 生成一个文本包,可用于模型上下文、离线评估或下游导入:

text
llms.txt                   # knowledge-map index
llms-full.txt              # consolidated approved text
llms/pages/<identity>.txt  # individual articles

定制分发,而不分叉知识 ​

知识包模板决定分发形态,例如额外的 Agent 指令、静态文件和查询辅助工具,但永远不会取代已批准的知识成为事实来源。站点的展示源码,例如首页插槽、自定义页面和主题组件,放在 src/site/ 下,与生成的知识分开。