mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-03 15:44:11 +00:00
docs: README 补文档站入口,并把「SDK 源码」链接迁到 GitHub
SDK 仓此前**没有任何地方指向文档站** —— README 不写、GitHub 仓的
homepage 字段也是空的,于是从仓首页根本走不到 sdk.homeagent.jianfgit.xyz。
文档站本身一直在线(106 个文件的 mkdocs 产物),只是没人从仓里指过去。
本次补上:
- README.md / README_EN.md 顶部加文档站入口(快速开始 / API 参考 / 能力边界
/ llms.txt + llms-full.txt 的 agent 直读入口),并在末尾加「文档」章节
列出全部页面的直链。
- mkdocs.yml 的社交链接由 gitcode 改指 GitHub,并**新增** gitcode 镜像入口与
介绍站入口(国内直连 gitcode 更快,海外/权威源看 GitHub,两个都留)。
- docs/guide/getting-started.md 的 `git clone` 地址改为 GitHub 仓名
(homeagentsdk),并写明「release 附件暂时仍在 gitcode」这个事实。
★ 刻意**不**改的东西:Go 模块路径 `gitcode.com/JianFeeeee/homeagent-sdk`。
改模块路径会让所有现有插件的 go.mod 全面失效,属于破坏性变更,
与「仓库托管位置迁移」是两件事。
关于 GitHub 侧没有 release 条目(因此不能写 releases/latest/download/...,
那会 404):已在 README 里如实写明 —— 二进制目前只在 gitcode 的 release 附件里,
GitHub 从下一个 SDK 版本(v1.4.0)起才会同步发布。
验证:两份 README 里 28 个 URL 全部实测 200;文档站重建(106 文件)并部署,
线上 `git clone` 已是 GitHub 地址、旧 gitcode clone 地址 0 次、
三个社交入口名称正确。
This commit is contained in:
10
mkdocs.yml
10
mkdocs.yml
@ -92,9 +92,17 @@ markdown_extensions:
|
||||
extra:
|
||||
generator: false
|
||||
social:
|
||||
# 主仓已迁到 GitHub;gitcode 保留为国内镜像(源码同步)。
|
||||
# 两个链接都放,是因为国内直连 gitcode 更快,而海外/权威源看 GitHub。
|
||||
- icon: fontawesome/solid/code
|
||||
link: https://github.com/JianFeeeee/homeagentsdk
|
||||
name: SDK 源码(GitHub)
|
||||
- icon: fontawesome/solid/code-branch
|
||||
link: https://gitcode.com/JianFeeeee/homeagent-sdk
|
||||
name: SDK 源码
|
||||
name: gitcode 镜像(国内)
|
||||
- icon: fontawesome/solid/house
|
||||
link: https://introduce.homeagent.jianfgit.xyz/
|
||||
name: HomeAgent 介绍站
|
||||
# 自定义检索端点在 docs/javascripts/api-search.js 里注册,
|
||||
# 索引文件由 gensite 产出:docs/assets/api-index.json
|
||||
|
||||
|
||||
Reference in New Issue
Block a user