mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-15 12:15:11 +00:00
docs: 文档与站点链接随托管地迁移到 GitHub
go module 路径已迁到 `github.com/JianFeeeee/homeagentsdk`(见上一提交),
文档里的示例 import、Releases 下载地址、模块路径引用同步更新。
涉及:README.md、README_EN.md、docs/guide/{getting-started,first-plugin,
capability-boundary}.md、mkdocs.yml。
## 有意保留的 gitcode 提及
**不是漏改**,删了反而让文档说谎:
- README.md:「二进制的实际分发地址目前是 gitcode」——两个仓的 release
附件不同步,只有二进制暂时还得去 gitcode 取
- mkdocs.yml:gitcode 镜像链接(国内直连更快,海外看 GitHub)
- docs/guide/getting-started.md:注明「gitcode 仅作国内镜像」
判据:**能照做的指引**优先于「链接好看」。读者照 README 下载 hmapdev
时,走 gitcode 是真能拿到东西的那条路。
This commit is contained in:
@ -351,7 +351,7 @@ func New(name string, sett SettingsAPI, regTool ToolRegistrar, regStage StageReg
|
||||
|
||||
> ⚠️ **二进制的实际分发地址目前是 gitcode**(两个仓的 release 附件不同步):
|
||||
> `hmapdev_linux_amd64` 等 5 个平台二进制 + `SHA256SUMS` 在
|
||||
> <https://gitcode.com/JianFeeeee/homeagent-sdk/releases>。
|
||||
> <https://github.com/JianFeeeee/homeagentsdk/releases>。
|
||||
> GitHub 侧(<https://github.com/JianFeeeee/homeagentsdk/releases>)从
|
||||
> 下一个 SDK 版本(v1.4.0)起才会同步发布 —— 因为 SDK 仓**移仓后还没发过版**。
|
||||
> 源码与文档一律以 GitHub 为准,**只有二进制暂时还得到 gitcode 取**。
|
||||
@ -363,7 +363,7 @@ func New(name string, sett SettingsAPI, regTool ToolRegistrar, regStage StageReg
|
||||
```bash
|
||||
# 从 release 附件下载(以 linux amd64 为例,<版本> 如 v1.3.0)
|
||||
# 当前实际分发地址是 gitcode(见下方说明):
|
||||
curl -Lo hmapdev https://gitcode.com/JianFeeeee/homeagent-sdk/releases/download/<版本>/hmapdev_linux_amd64
|
||||
curl -Lo hmapdev https://github.com/JianFeeeee/homeagentsdk/releases/download/<版本>/hmapdev_linux_amd64
|
||||
chmod +x hmapdev
|
||||
|
||||
# 或从源码自己编
|
||||
|
||||
@ -338,7 +338,7 @@ Plugin developers only need to implement the `Plugin` interface and export a `Ne
|
||||
`hmapdev` provides full development workflow support and produces `.hmap` plugin bundles (the tool is
|
||||
named after that package format). Prebuilt binaries ship as **release assets**
|
||||
(linux/darwin/windows × amd64/arm64); download from
|
||||
[Releases](https://gitcode.com/JianFeeeee/homeagent-sdk/releases) and put it on your PATH:
|
||||
[Releases](https://github.com/JianFeeeee/homeagentsdk/releases) and put it on your PATH:
|
||||
|
||||
> Rename note: the toolchain was called `plugindev` and is `hmapdev` since 1.2.0.
|
||||
> The SDK store moved from `~/.homeagent/plugindev/sdk` to `~/.homeagent/hmapdev/sdk`
|
||||
@ -346,7 +346,7 @@ named after that package format). Prebuilt binaries ship as **release assets**
|
||||
|
||||
```bash
|
||||
# From release assets (latest SDK release / linux amd64 shown)
|
||||
curl -Lo hmapdev https://gitcode.com/JianFeeeee/homeagent-sdk/releases/download/<version>/hmapdev_linux_amd64
|
||||
curl -Lo hmapdev https://github.com/JianFeeeee/homeagentsdk/releases/download/<version>/hmapdev_linux_amd64
|
||||
chmod +x hmapdev
|
||||
|
||||
# Or build from source
|
||||
|
||||
@ -7,7 +7,7 @@ HomeAgent 有两类插件:
|
||||
| **外部插件** | 第三方开发,编译成 `.hmap` 后安装 | 独立分发,**可闭源** |
|
||||
| **内置插件** | 编译进内核,`init()` 自注册 | 随内核发行,需合入主仓 |
|
||||
|
||||
SDK 包是**同一个** `gitcode.com/JianFeeeee/homeagent-sdk/sdk`,但两类插件拿到的
|
||||
SDK 包是**同一个** `github.com/JianFeeeee/homeagentsdk/sdk`,但两类插件拿到的
|
||||
**能力不同**:外部插件跑在独立进程里,由内核通过桥接注入能力(IPC,不是共享内存里的直接调用)。
|
||||
|
||||
本页说明边界在哪、为什么,以及**怎么在写代码前就知道某个 API 是否可用**。
|
||||
|
||||
@ -56,7 +56,7 @@ package main
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"gitcode.com/JianFeeeee/homeagent-sdk/sdk"
|
||||
"github.com/JianFeeeee/homeagentsdk/sdk"
|
||||
)
|
||||
|
||||
type Plugin struct {
|
||||
|
||||
@ -23,8 +23,8 @@ go build -o hmapdev
|
||||
共 5 个平台:linux/darwin/windows × amd64/arm64)。
|
||||
|
||||
> 仓已迁到 GitHub;gitcode 仅作国内镜像(源码同步,**release 附件暂时仍在那里**):
|
||||
> `https://gitcode.com/JianFeeeee/homeagent-sdk/releases`。
|
||||
> Go 模块路径仍是 `gitcode.com/JianFeeeee/homeagent-sdk` —— 这是有意保留的,
|
||||
> `https://github.com/JianFeeeee/homeagentsdk/releases`。
|
||||
> Go 模块路径仍是 `github.com/JianFeeeee/homeagentsdk` —— 这是有意保留的,
|
||||
> 改模块路径会让现有插件的 `go.mod` 全面失效。
|
||||
|
||||
## SDK 版本管理
|
||||
|
||||
@ -98,7 +98,7 @@ extra:
|
||||
link: https://github.com/JianFeeeee/homeagentsdk
|
||||
name: SDK 源码(GitHub)
|
||||
- icon: fontawesome/solid/code-branch
|
||||
link: https://gitcode.com/JianFeeeee/homeagent-sdk
|
||||
link: https://github.com/JianFeeeee/homeagentsdk
|
||||
name: gitcode 镜像(国内)
|
||||
- icon: fontawesome/solid/house
|
||||
link: https://introduce.homeagent.jianfgit.xyz/
|
||||
|
||||
Reference in New Issue
Block a user