docs: 文档统一迁移至lpt-docs
This commit is contained in:
@@ -17,6 +17,7 @@
|
||||
|
||||
| 目录 | 用途 |
|
||||
|------|------|
|
||||
| `lpt-docs` | 概念与设计文档项目,只维护系统概念和设计思路 |
|
||||
| `lpt-be` | Java Spring Boot 后端,提供 REST API、认证、数据库访问 |
|
||||
| `lpt-fe` | Vue 3 + TypeScript 前端 |
|
||||
| `lpt-ai` | TypeScript + Fastify 独立 AI 服务 |
|
||||
@@ -30,6 +31,7 @@
|
||||
| `lpt-fe` | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-fe.git` | `master` |
|
||||
| `lpt-ai` | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-ai.git` | `main` |
|
||||
| `lpt-infra` | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-infra.git` | `master` |
|
||||
| `lpt-docs` | `ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-docs.git` | `main` |
|
||||
|
||||
## 首次初始化
|
||||
|
||||
@@ -46,6 +48,7 @@ git clone -b master ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-be.git lpt-be
|
||||
git clone -b master ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-fe.git lpt-fe
|
||||
git clone -b main ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-ai.git lpt-ai
|
||||
git clone -b master ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-infra.git lpt-infra
|
||||
git clone -b main ssh://git@git.cat-shark.xyz:2222/cat-shark/lpt-docs.git lpt-docs
|
||||
```
|
||||
|
||||
clone 完成后,进入或修改某个子项目前,先读取该子项目根目录的 `AGENTS.md`;如果缺失,则读取 `README.md`。
|
||||
@@ -58,6 +61,13 @@ clone 完成后,进入或修改某个子项目前,先读取该子项目根
|
||||
- 对子项目执行 Git 操作时使用 `git -C lpt-be <command>` 这类形式。
|
||||
- 如果某个子项目目录已存在但不是 Git 仓库,或 clone 因 SSH 权限/网络失败,应停止并说明原因,不要用空目录或本地副本替代。
|
||||
|
||||
## 文档维护
|
||||
|
||||
- 所有系统文档统一在 `lpt-docs` 仓库维护,代码仓库不保留 README、`docs/` 等文档文件。
|
||||
- 代理协作规范保留在各仓库 `AGENTS.md`。
|
||||
- `lpt-docs` 只维护系统概念描述和设计思路,不保存开发记录、系统中间态和开发过程产物。
|
||||
- 修改 `lpt-docs` 后,如需在 meta 仓库补充说明,保持 meta 仓库不复制文档正文。
|
||||
|
||||
## 跨项目调用关系
|
||||
|
||||
```text
|
||||
|
||||
Reference in New Issue
Block a user