mirror of
https://github.com/hpd840321/starRiverProperty.git
synced 2026-06-09 08:20:31 +08:00
717b9a9240
- Neutral titles (starRiverProperty); 源码归档 wording; paths unchanged - Parent artifactIds: cloudwalk-cloud-reactor, cw-elevator-application-reactor, etc. - cw.elevator.v1.lib.dir and deploy script use repo-relative paths - package-info and module descriptions cleaned Made-with: Cursor
47 lines
2.6 KiB
Markdown
47 lines
2.6 KiB
Markdown
# 文档索引(starRiverProperty)
|
||
|
||
本目录集中存放说明类文档与配套资源,按类别分子目录。
|
||
|
||
## 目录结构
|
||
|
||
| 目录 | 说明 |
|
||
|------|------|
|
||
| [business/](business/) | 业务走查、接口流、用例说明 |
|
||
| [build/](build/) | 构建环境、JDK 版本依据等 |
|
||
| [style/](style/) | 代码风格配置(P3C / Eclipse Formatter XML,供 Maven `formatter-maven-plugin` 引用) |
|
||
| [operations/](operations/) | 发布、私服上传等运维脚本 |
|
||
| [architecture/](architecture/) | 工程结构、Maven 聚合模块说明与模块间关系 |
|
||
|
||
源码归档(`*.jar.src` / `*.jar.src.zip`)不在 `docs/` 内,而在仓库根目录 [**`artifacts/decompiled/`**](../artifacts/decompiled/)(目录名 `decompiled` 为历史约定;与本文并列,见该目录 README)。
|
||
|
||
## 文档列表
|
||
|
||
### 工程说明(architecture)
|
||
|
||
- [Maven 聚合工程说明](architecture/Maven聚合工程说明.md) — 五个 `maven-*` 聚合工程的定位、子模块、技术栈、工程间依赖与 `artifacts`/运行包分工。
|
||
|
||
### 业务(business)
|
||
|
||
- [访客注册与派梯楼层业务流程走查](business/访客注册与派梯楼层业务流程走查.md) — 从第三方获取默认楼层到指定楼层、电梯 `add/visitor`、Feign 调用链与用例。
|
||
- [租户访客默认楼层技术产品方案](business/租户访客默认楼层技术产品方案.md) — 从第三方登记页初始化(数据项与接口溯源)到派梯开通的**闭环**、多租户默认楼层的实现路径评估与落地建议。
|
||
|
||
### 构建(build)
|
||
|
||
- [ORIGINAL_BUILD_JDK.txt](build/ORIGINAL_BUILD_JDK.txt) — 原始运行包与构件体现的 **JDK 8** 依据;与各聚合父 POM 中 `maven-enforcer-plugin` 提示一致。
|
||
|
||
### 风格(style)
|
||
|
||
- [alibaba-eclipse-codestyle.xml](style/alibaba-eclipse-codestyle.xml) — 阿里巴巴 P3C Eclipse 格式化配置;各 `maven-*/pom.xml` 中 `alibaba.eclipse.codestyle.path` 指向此处。
|
||
|
||
### 运维(operations)
|
||
|
||
- [deploy_cw_elevator_v1_lib_to_nexus.py](operations/deploy_cw_elevator_v1_lib_to_nexus.py) — 将 V1 运行包 `lib` 下 JAR 批量 `deploy-file` 到 Nexus 的脚本。
|
||
|
||
## 源码归档与解压树(`artifacts/`)
|
||
|
||
说明类文档在 **`docs/`**;由运行 JAR 还原得到的 **`*.jar.src.zip` / `*.jar.src/`** 已归纳至仓库根目录 **`artifacts/decompiled/`**(`archives` 与 `trees` 分类),详见 [artifacts/decompiled/README.md](../artifacts/decompiled/README.md)。
|
||
|
||
## 与 `dev-support` 的关系
|
||
|
||
原 `dev-support/` 下文档与配置已迁入 `docs/` 对应子目录。若本地仍有旧路径书签,请改为以 `docs/` 为准。
|