From 64c008501fcda99ea92c2b148adf51dc1153f013 Mon Sep 17 00:00:00 2001 From: JianFeeeee Date: Tue, 29 Sep 2026 20:52:32 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=B8=BB=E4=BB=93=20README=20=E8=A1=A5?= =?UTF-8?q?=E5=9C=A8=E7=BA=BF=E6=96=87=E6=A1=A3=E5=85=A5=E5=8F=A3=EF=BC=88?= =?UTF-8?q?=E4=BB=8B=E7=BB=8D=E7=AB=99=20+=20SDK=20=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E7=AB=99=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 与 SDK 仓同一个问题：主仓 README 的「文档」章节只列了仓内 markdown （assets/docs/...），没有任何**在线**地址 —— 而主仓 README 正是绝大多数人 的第一入口，从它走不到介绍站与 SDK 文档站。 改为两段并列： **在线文档**：介绍站 + SDK 文档站（含 llms.txt / llms-full.txt 的 agent 直读入口） **仓内文档**（随代码版本走）：原有的 OVERVIEW / ARCHITECTURE / PLUGIN_DEV 等 分开标注是有意的：在线站与内核版本**不严格对齐**（站点按发布节奏更新）， 而仓内文档跟代码走。写清楚归属，读者才知道该信哪个。 中英文两份同步；两处 README 的 7 个 URL 全部实测 200。 --- README.md | 9 +++++++++ README_EN.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/README.md b/README.md index f8d20cb..0438965 100644 --- a/README.md +++ b/README.md @@ -330,6 +330,15 @@ internal/ ## 文档 +**在线文档**： + +- 介绍站（项目总览）： +- 插件 SDK 文档（快速开始 / API 参考 / 指南 / 示例）： + —— 面向 agent 的纯文本入口：[`llms.txt`](https://sdk.homeagent.jianfgit.xyz/llms.txt) / + [`llms-full.txt`](https://sdk.homeagent.jianfgit.xyz/llms-full.txt) + +**仓内文档**（随代码版本走）： + - [项目概览](assets/docs/zh/OVERVIEW.md) | [English](assets/docs/en/OVERVIEW.md) - [技术架构](assets/docs/zh/ARCHITECTURE.md) | [English](assets/docs/en/ARCHITECTURE.md) - [插件开发指南](assets/docs/zh/PLUGIN_DEV.md) | [English](assets/docs/en/PLUGIN_DEV.md) diff --git a/README_EN.md b/README_EN.md index 3d6c3a9..39b6d53 100644 --- a/README_EN.md +++ b/README_EN.md @@ -350,6 +350,15 @@ semantic memory; the blob is only a cache that capacity GC may evict. ## Documentation +**Online docs**: + +- Introduction site (project overview): +- Plugin SDK docs (getting started / API reference / guides / examples): + — agent-friendly plain text: [`llms.txt`](https://sdk.homeagent.jianfgit.xyz/llms.txt) / + [`llms-full.txt`](https://sdk.homeagent.jianfgit.xyz/llms-full.txt) + +**In-repo docs** (versioned with the code): + - [Project Overview](assets/docs/en/OVERVIEW.md) | [中文](assets/docs/zh/OVERVIEW.md) - [Technical Architecture](assets/docs/en/ARCHITECTURE.md) | [中文](assets/docs/zh/ARCHITECTURE.md) - [Plugin Development Guide](assets/docs/en/PLUGIN_DEV.md) | [中文](assets/docs/zh/PLUGIN_DEV.md)