Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 3.29 KB

File metadata and controls

43 lines (33 loc) · 3.29 KB

HugAgentOS 文档 / Documentation

最后更新:2026-07-21

HugAgentOS 是一个企业级 AI Agent 平台(FastAPI + React + AgentScope 2.0),以 open-core 模式提供 开源社区版(CE)商业版(EE) 双形态。产品文档按语言分树维护:

HugAgentOS is an enterprise-grade AI agent platform (FastAPI + React + AgentScope 2.0), shipped in an open-core model as a Community Edition (CE) and an Enterprise Edition (EE). Product documentation is maintained per language:

语言 / Language 入口 / Entry
简体中文 zh-CN/README.md
English en/README.md

两棵树文件名一一对应,内容互为镜像。Both trees mirror each other file-by-file.

文档结构 / Structure

document/
├── zh-CN/ · en/             # 双语产品文档(镜像)
│   ├── getting-started/     # 产品简介、快速开始、领域本体快速入门
│   ├── deployment/          # 部署总览(选型) + 无 Docker 一键安装 / Docker Compose / 离线生产 / Windows(WSL2) / 环境变量参考
│   ├── architecture/        # 总体架构、后端、前端、数据模型
│   ├── modules/             # 17 个功能模块文档(对话/提示词/能力目录/模型/
│   │                        #   MCP 工具/技能/沙箱/记忆/知识库/存储/项目空间/
│   │                        #   认证/管理台/自动化/画布与产物)
│   ├── api/                 # API 总览(信封/鉴权/SSE/路由清单)、错误码
│   ├── editions/            # 社区版 vs 商业版、License 机制、CE 构建管线
│   └── development/         # 后端 / 前端开发指南
└── internal/                # ⚠️ 内部文档(仅主仓,不随社区版分发)
    ├── sandbox-snapshot-design.md            # 沙箱快照持久化设计(已实现,被代码注释引用)
    ├── ontology-harness-implementation.md     # 本体驱动 Harness 工程实施与治理边界
    ├── 开源与商业化产品方案.md                 # CE/EE 产品与商业策略(权威边界来源)
    ├── community-commercial-edition-plan.md  # CE/EE 拆分施工图(逐行技术方案)
    └── ce-ee-repo-restructure-plan.md        # CE/EE 仓库结构与生成管线方案

开源边界 / Open-source boundary

  • zh-CN/en/ 与本索引是公开产品文档:随社区版(CE)派生树一并开源。商业版(EE)独有能力在文中以「商业版 EE」/ "(EE)" 显式标注——这与 Dify / FastGPT 在公开文档中介绍企业版能力的做法一致。公开树内不得出现内部 IP、凭据、客户信息与商业策略内容。
  • internal/内部文档(商业方案、拆分施工图、内部设计稿):由 ce/manifest.yamlexclude: internal design docs 保证永不进入社区版派生树。新增内部文档一律放这里。

zh-CN/, en/, and this index are public product docs, shipped with the Community Edition derived tree; EE-only capabilities are explicitly labeled. internal/ holds internal documents (business strategy, split blueprints, design drafts) and is excluded from the CE tree via ce/manifest.yaml — put any new internal document there.