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)