本文档由 g2rain-basis 的 docs/index.md 自动同步生成。
# g2rain-basis 文档

这里是 g2rain-basis 的项目级技术文档,也是根 README、架构验证和后续文档站点的事实来源。

项目当前按组织级 java-domain-service 1.0.0 (opens new window) 进行接入准备,状态为 planned。中央 Profile 管理同类服务公共规则,本目录维护 Basis 的领域设计、当前实现和架构差异。

# 项目定位

g2rain-basis 是 g2rain 平台的核心主数据与权限治理服务。它维护组织、用户、通行证、应用、资源、角色、权限和外部身份关系,并向 IAM、网关、管理端及其他平台服务提供领域能力。

# 阅读路径

# 了解架构

# 开发与验证

# 运行与维护

# 专题设计

# 社区

# 文档维护约定

  • README 只保留项目定位、快速开始、架构摘要和文档导航。
  • docs/project.yaml 保存机器可读取的项目职责、模块和命令声明。
  • 架构的“为什么”通过 ADR 或专题设计文档记录。
  • 代码正确性由项目测试保障;文档与架构声明的一致性由 Agent 结合源码、POM 和 Git Diff 动态检查。
  • 修改模块、依赖方向、启动命令、生成流程或运行配置时,应在同一提交中更新相关文档。