mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-09-30 06:22:53 +00:00
docs: 主仓 README 补在线文档入口(介绍站 + SDK 文档站)
与 SDK 仓同一个问题:主仓 README 的「文档」章节只列了仓内 markdown (assets/docs/...),没有任何**在线**地址 —— 而主仓 README 正是绝大多数人 的第一入口,从它走不到介绍站与 SDK 文档站。 改为两段并列: **在线文档**:介绍站 + SDK 文档站(含 llms.txt / llms-full.txt 的 agent 直读入口) **仓内文档**(随代码版本走):原有的 OVERVIEW / ARCHITECTURE / PLUGIN_DEV 等 分开标注是有意的:在线站与内核版本**不严格对齐**(站点按发布节奏更新), 而仓内文档跟代码走。写清楚归属,读者才知道该信哪个。 中英文两份同步;两处 README 的 7 个 URL 全部实测 200。
This commit is contained in:
@ -330,6 +330,15 @@ internal/
|
||||
|
||||
## 文档
|
||||
|
||||
**在线文档**:
|
||||
|
||||
- 介绍站(项目总览):<https://introduce.homeagent.jianfgit.xyz/>
|
||||
- 插件 SDK 文档(快速开始 / API 参考 / 指南 / 示例):<https://sdk.homeagent.jianfgit.xyz/>
|
||||
—— 面向 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)
|
||||
|
||||
@ -350,6 +350,15 @@ semantic memory; the blob is only a cache that capacity GC may evict.
|
||||
|
||||
## Documentation
|
||||
|
||||
**Online docs**:
|
||||
|
||||
- Introduction site (project overview): <https://introduce.homeagent.jianfgit.xyz/>
|
||||
- Plugin SDK docs (getting started / API reference / guides / examples): <https://sdk.homeagent.jianfgit.xyz/>
|
||||
— 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)
|
||||
|
||||
Reference in New Issue
Block a user