docs: 合集加入分类方案与Gitea镜像同步方案,收录astryx
This commit is contained in:
1 parent
5ae4635a91
commit
29f4d88d3f
4 files changed
+156
-25
No files matched your search
@@ -1,48 +1,42 @@
|
||||
# 关注的代码库合集(Codebase Collection)
|
||||
|
||||
> 用途:聚合我们关注 / 追踪的代码库,通过 **Git 子模块(submodule)** 统一管理。
|
||||
> 用途:聚合我们关注 / 追踪的代码库。外部代码库**镜像同步到 git.vanusys.com**(保证国内/内网可达),合集中通过 Git 子模块统一引用。
|
||||
> 更新日期:2026-08-16
|
||||
> 相关文档:[分类方案](分类方案.md) · [镜像同步方案](同步方案.md)
|
||||
|
||||
## 收录清单
|
||||
|
||||
> 待补充。格式约定:
|
||||
> 分类见 [分类方案.md](分类方案.md);镜像状态:`待建远程镜像` = git.vanusys.com 上还没有镜像仓库。
|
||||
|
||||
| 名称 | 子模块路径 | 仓库地址 | 用途 | 关注原因 | 备注 |
|
||||
|------|-----------|---------|------|---------|------|
|
||||
| (示例)LiveKit | livekit/livekit | https://github.com/livekit/livekit | SFU 视频会议服务 | 自建媒体服务器核心 | 外部仓库,考虑镜像 |
|
||||
| 名称 | 分类 | 子模块路径 | 镜像地址(git.vanusys.com) | 上游地址 | 用途 | 关注原因 | 镜像状态 |
|
||||
|------|------|-----------|---------------------------|---------|------|---------|---------|
|
||||
| Astryx | frontend | frontend/astryx | VanuSystems/facebook-astryx | https://github.com/facebook/astryx | Meta 开源设计系统(可定制、Agent-ready) | AI 前端 / 设计系统方向,官网可跟踪 | 待建远程镜像 |
|
||||
|
||||
## 使用说明
|
||||
|
||||
- **首次克隆**(含全部子模块):
|
||||
- **首次克隆**(含全部子模块,全部走内部镜像,无需外网):
|
||||
|
||||
```bash
|
||||
git clone --recursive <合集仓库地址>
|
||||
```
|
||||
|
||||
- **拉取全部子模块最新代码**(跟随上游):
|
||||
- **跟随上游最新代码**(更新子模块引用后需提交):
|
||||
|
||||
```bash
|
||||
git submodule update --remote
|
||||
```
|
||||
|
||||
- **新增一个代码库**:
|
||||
|
||||
```bash
|
||||
git submodule add <仓库地址> <子模块路径>
|
||||
git commit -m "chore: 收录 <名称>"
|
||||
```
|
||||
|
||||
- **更新子模块引用并提交**:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "chore: 同步子模块引用"
|
||||
```
|
||||
|
||||
## 收录规范(建议)
|
||||
- **新增一个代码库**(完整流程见 [分类方案.md](分类方案.md) 收录流程):
|
||||
|
||||
- **内部仓库**(git.vanusys.com 上):直接以子模块收录。
|
||||
- **外部开源仓库**(GitHub 等):
|
||||
- 优先在 git.vanusys.com 建立镜像后再收录,避免子模块依赖外部网络(国内服务器拉取 GitHub 可能超时);
|
||||
- 或仅在本表登记地址与用途,不强制挂子模块。
|
||||
- 子模块只记录**提交引用**,不会自动跟随上游改动,需定期 `git submodule update --remote` 同步。
|
||||
```bash
|
||||
git submodule add <内部镜像地址> <分类>/<仓库名>
|
||||
git commit -m "chore: 收录 <名称>"
|
||||
```
|
||||
|
||||
## 收录规范
|
||||
|
||||
- **子模块一律指向内部镜像地址**(git.vanusys.com),不直接指向 GitHub —— 保证合集在宁波/内网环境可完整 clone。
|
||||
- **镜像维护**:运行 `tools/sync-mirrors.ps1` 或服务器定时任务(见 [同步方案.md](同步方案.md)),定期把上游变更推到内部镜像。
|
||||
- 子模块记录的是**提交引用**,不会自动跟随上游,需定期执行 `git submodule update --remote` 并人工确认提交。
|
||||
Reference in new issue
Block a user