Refactor documentation:
Some checks failed
ci / release-gate (push) Has been cancelled

- Remove outdated development plan from `development-plan.md`.
- Update `operations.md` to include details on authorization cache configuration.
- Revise `quickstart.md` for clarity on local development setup and database initialization.
- Delete redundant `redis-authorization-cache.md`.
- Add new `tenant-provisioning.md` to document the process of setting up a tenant from an empty database.
This commit is contained in:
2026-08-03 10:27:35 +08:00
parent 33a08bfaab
commit fe594c9ef5
11 changed files with 329 additions and 540 deletions

View File

@@ -2,14 +2,25 @@
这里仅记录当前代码已经实现的架构、运行方式和维护约束。接口细节以 Development 环境的 OpenAPI/Scalar 为准,数据库结构以 EF Core Migration 和模型快照为准。
## 阅读入口
## 从这里开始
| 文档 | 内容 | 适合谁 |
| --- | --- | --- |
| [本地开发与运行](quickstart.md) | PostgreSQL 初始化、启动 API、验证命令、常见问题 | 新开发者 |
| [系统架构与业务边界](architecture/overview.md) | 项目依赖、运行时组件、当前业务模块和后台任务链路 | 开发与评审人员 |
| [认证、授权与租户隔离](architecture/security-and-tenancy.md) | 登录、Session、JWT、Cookie/CSRF、Realm、RBAC、Capability、DataScope、租户隔离 | API 与安全开发者 |
| [配置与后台任务](operations.md) | 环境配置、Production 启动门禁、Redis、Worker、ClamAV 和健康检查 | 开发与运维人员 |
| 目标 | 文档 |
| --- | --- |
| 首次拉取代码,启动本地开发环境 | [本地开发快速上手](quickstart.md) |
| 从空库验收租户创建、Owner 激活和站点发布 | [空数据库到租户建站验收](tenant-provisioning.md) |
| 理解项目分层、运行时和业务边界 | [系统架构与业务边界](architecture/overview.md) |
| 修改认证、权限或租户数据 | [认证、授权与租户隔离](architecture/security-and-tenancy.md) |
| 部署 API/Worker、配置依赖或排查任务 | [配置与后台任务](operations.md) |
## 文档边界
- `README.md`:项目定位、最短启动入口和仓库地图。
- `docs/quickstart.md`:非破坏性的日常开发路径。
- `docs/tenant-provisioning.md`:会创建或清理本地数据库的完整 SaaS 验收路径。
- `docs/architecture/**`:当前代码的稳定设计与安全边界。
- `docs/operations.md`:部署配置、后台处理、健康检查和恢复演练。
路线图、阶段计划、代码评审快照和历史迁移过程不放在当前实现文档中;需要保留时应进入 Issue、项目管理系统或明确标记的历史归档。
## 权威来源
@@ -25,4 +36,5 @@
2. 新增租户实体时,同时验证 Query Filter、租户唯一索引、组合外键和写入拦截器。
3. 数据库结构变更必须生成 EF Core Migration并检查 migration script 和 pending model changes。
4. 不在文档中保存连接密码、JWT 私钥、证书密码、Provider 密钥或平台管理员临时密码。
5. 不再维护阶段路线图、旧后端接口对比、评审快照或开发过程记录
5. 代码行为变化时更新对应主题,不新增内容重叠的临时说明文件
6. 不维护阶段路线图、旧后端接口对比、评审快照或开发过程记录。