refactor: 文档维护点收归mipu-api,新增SDK
- 移除 docs/ 和 Release CI,文档维护点收归 mipu-api 子模块 - 新增 sdk/mipu_requests Python SDK(构造参数传入凭据) - 新增 CLAUDE.md 标注文档维护路径 - 精简 README Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
40
README.md
40
README.md
@@ -6,53 +6,17 @@
|
||||
|
||||
| 子项目 | 说明 |
|
||||
|--------|------|
|
||||
| [mipu-api](./mipu-api/) | Claude Code 开发 Skill,辅助外部开发者快速对接米普 API |
|
||||
| docs/ | API 文档源文件(本仓库维护,通过 Release 发布 tar 包) |
|
||||
| mipu-sdk | 开发 SDK(待添加) |
|
||||
|
||||
## 文档发布流程
|
||||
|
||||
文档源文件在 `docs/` 目录维护。发布新版本:
|
||||
|
||||
```bash
|
||||
# 1. 修改 docs/ 下的文档
|
||||
# 2. 提交并打 tag
|
||||
git add docs/
|
||||
git commit -m "更新API文档"
|
||||
git tag v1.1.0
|
||||
git push && git push --tags
|
||||
|
||||
# Gitea Actions 自动:
|
||||
# - 打包 docs/ 为 docs.tar.gz
|
||||
# - 创建 Release 并附加 docs.tar.gz
|
||||
```
|
||||
|
||||
Skill 端会在每次调用时自动检查 Release 版本并下载更新。
|
||||
| [mipu-api](./mipu-api/) | Claude Code 开发 Skill,API 文档在其 `plugins/.../docs/` 内维护 |
|
||||
| [sdk/mipu_requests](./sdk/mipu_requests/) | Python SDK,封装米普 API 调用 |
|
||||
|
||||
## 快速开始
|
||||
|
||||
克隆主仓库及所有子模块:
|
||||
|
||||
```bash
|
||||
git clone --recurse-submodules <this-repo-url>
|
||||
```
|
||||
|
||||
如果已经克隆了主仓库:
|
||||
|
||||
```bash
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
## 更新子模块
|
||||
|
||||
拉取所有子模块的最新更新:
|
||||
|
||||
```bash
|
||||
git submodule update --remote
|
||||
```
|
||||
|
||||
## 添加新子模块
|
||||
|
||||
```bash
|
||||
git submodule add <repo-url> <directory-name>
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user