diff --git a/AGENTS.md b/AGENTS.md index c3a54880..d9b2586c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -5,7 +5,7 @@ ### 1. 开发指导规范 (AI & Developer Guidelines) * **必须阅读**： - * **[docs/guideline/development-constraints.md](./docs/guideline/development-constraints.md)**：掌握核心后端/Agent/前端分层约束、数据模型规范、数据库迁移升级协议、API 与鉴权设计准则及变更准入与验收标准。 + * **[docs/guideline/development-constraints.md](docs/guideline/Constraints.md)**：掌握核心后端/Agent/前端分层约束、数据模型规范、数据库迁移升级协议、API 与鉴权设计准则及变更准入与验收标准。 * **[docs/guideline/Role.md](./docs/guideline/Role.md)**：通用的 Go 后端开发与高质量编码准则，包括架构、并发、错误处理、安全及工作流程。 * **正在进行的开发计划与接手 (Handover & Plans)**： * **[docs/plan/index.md](./docs/plan/index.md)**：查看正在进行的开发实现计划（Implementation Plan）与 AI 代理交接文档（Handover），接手项目时优先检查。 diff --git a/docs/design/architecture.md b/docs/design/architecture.md index 1fe7a1a3..33100f00 100644 --- a/docs/design/architecture.md +++ b/docs/design/architecture.md @@ -70,7 +70,7 @@ OpenResty (Agent, TLS/WAF) | **OpenResty** | 接收真实流量，执行 WAF 过滤、PoW 防护、Basic Auth 认证与静态/反代服务 | [WAF 设计](./waf-design.md) / [Pages 设计](./pages-design.md) | | **Relay** | 部署于边缘节点，管理 `frps` 守护进程生命周期，接受心跳派发的穿透中继配置 | [内网穿透设计](./tunnel-design.md) | | **OpenFlared** | 部署于内网，管理 `frpc` 进程组，向多个 Relay 建立反向隧道，上报连接状态 | [内网穿透设计](./tunnel-design.md) | -| **Frontend** | Next.js 管理界面，提供路由、WAF、证书、节点、穿透隧道和 Pages 项目的可视化管理 | [开发约束](../guideline/development-constraints.md) | +| **Frontend** | Next.js 管理界面，提供路由、WAF、证书、节点、穿透隧道和 Pages 项目的可视化管理 | [开发约束](../guideline/Constraints.md) | --- @@ -164,7 +164,7 @@ OpenResty (Agent, TLS/WAF) 修改系统架构或开发新功能前，请按以下顺序阅读： 1. **[产品边界](./index.md)**：了解 OpenFlare 核心定位与不允许逾越的设计边界。 -2. **[开发约束](../guideline/development-constraints.md)**：掌握数据模型、API 约定、数据库迁移（Goose）与前端规范。 +2. **[开发约束](../guideline/Constraints.md)**：掌握数据模型、API 约定、数据库迁移（Goose）与前端规范。 3. **[Agent 与发布模型](./agent-design.md)**：理解版本快照同步及失败回滚的安全兜底逻辑。 4. **细分领域设计**： * 穿透相关开发：阅读 [内网穿透隧道设计](./tunnel-design.md)。 diff --git a/docs/design/index.md b/docs/design/index.md index 42dd1a1d..9df4ebd8 100644 --- a/docs/design/index.md +++ b/docs/design/index.md @@ -164,6 +164,6 @@ OpenFlare 适合需要统一管理多台 OpenResty 代理节点的团队，具 * 产品范围或系统边界变化：更新本文档（[产品边界](./index.md)）。 * 系统结构、组件分工变化：更新 [系统架构](./architecture.md)。 * 发布、同步、回滚与 Agent 模型变化：更新 [Agent 与发布模型](./agent-design.md)。 -* 开发约束、代码规范、接口约定变化：更新 [开发约束](../guideline/development-constraints.md)。 +* 开发约束、代码规范、接口约定变化：更新 [开发约束](../guideline/Constraints.md)。 * 部署方式变化：更新 [部署说明](../deployment/deployment.md) 与 README。 * 配置项变化：更新 [配置项参考](../reference/configuration.md)。 diff --git a/docs/en/design/architecture.md b/docs/en/design/architecture.md index 97a26235..bb77120a 100644 --- a/docs/en/design/architecture.md +++ b/docs/en/design/architecture.md @@ -219,5 +219,5 @@ Before modifying architectural code, please read: 1. [Product Boundaries](./index.md) 2. [Agent & Publish Model](./agent-design.md) -3. [Development Constraints](../../guideline/development-constraints.md) +3. [Development Constraints](../../guideline/Constraints.md) 4. [Repository Structure](./repository.md) diff --git a/docs/en/design/development.md b/docs/en/design/development.md index df44130e..334d4470 100644 --- a/docs/en/design/development.md +++ b/docs/en/design/development.md @@ -2,7 +2,7 @@ You will learn: How to build OpenFlare's local development environment, start the Server, the Agent, and the Admin Frontend, run test and build commands, and understand the boundaries to respect before contributing code. -This page is aimed at contributors. Product boundaries, data model constraints, API conventions, and frontend layering specifications are governed by [Development Constraints](../../guideline/development-constraints.md); this page only provides actionable workflows for local development. +This page is aimed at contributors. Product boundaries, data model constraints, API conventions, and frontend layering specifications are governed by [Development Constraints](../../guideline/Constraints.md); this page only provides actionable workflows for local development. ## Repository Structure diff --git a/docs/en/design/index.md b/docs/en/design/index.md index 888c3fde..35e842b0 100644 --- a/docs/en/design/index.md +++ b/docs/en/design/index.md @@ -197,7 +197,7 @@ IP Group & Judgment Constraints: * Update this document when the product range or system boundaries change. * Update [System Architecture](./architecture.md) when the system structure or module responsibilities change. * Update [Agent & Publish Model](./agent-design.md) when the publishing, synchronization, rollback, or Agent model changes. -* Update [Development Constraints](../../guideline/development-constraints.md) when developer constraints, code specifications, or API conventions change. +* Update [Development Constraints](../../guideline/Constraints.md) when developer constraints, code specifications, or API conventions change. * Update README and [Deployment Instructions](../../deployment/deployment.md) when deployment methods change. * Update [Configurations Reference](../reference/configuration.md) when configuration items change. * Completed phases should no longer be backfilled as "version plans". diff --git a/docs/en/guide/index.md b/docs/en/guide/index.md index 72d70ccd..e72964d0 100644 --- a/docs/en/guide/index.md +++ b/docs/en/guide/index.md @@ -30,7 +30,7 @@ If you are new to OpenFlare, read the documents in the following order: | Start Server from source code | [Launch Server](../deployment/server.md) | | Configure GitHub or OIDC SSO | [SSO Login Configuration](./sso.md) | | Upgrade Server or Agent | [Upgrade & Maintenance](../deployment/upgrade.md) | -| Participate in development or bug fixing | [Local Development](../design/development.md) and [Development Constraints](../../guideline/development-constraints.md) | +| Participate in development or bug fixing | [Local Development](../design/development.md) and [Development Constraints](../../guideline/Constraints.md) | | Understand architecture and publishing | [System Architecture](../design/architecture.md) and [Agent & Publish Model](../design/agent-design.md) | | View open-source references and credits | [Credits](./credits.md) | diff --git a/docs/guide/index.md b/docs/guide/index.md index 2871cbfd..f9f73f8e 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -36,7 +36,7 @@ OpenFlare 是一套自托管的 OpenResty 控制面。它把反向代理网站 | 从源码启动 Server | [启动 Server](../deployment/server.md) | | 配置 GitHub 或 OIDC 登录 | [SSO 登录配置](./sso.md) | | 升级 Server 或 Agent | [升级与维护](../deployment/upgrade.md) | -| 参与开发或修复问题 | [启动 Server](../deployment/server.md) 与 [开发约束](../guideline/development-constraints.md) | +| 参与开发或修复问题 | [启动 Server](../deployment/server.md) 与 [开发约束](../guideline/Constraints.md) | | 理解架构和发布模型 | [系统架构](../design/architecture.md) 与 [Agent 与发布模型](../design/agent-design.md) | | 查看开源引用与致谢 | [引用与致谢](./credits.md) | diff --git a/docs/guideline/development-constraints.md b/docs/guideline/Constraints.md similarity index 100% rename from docs/guideline/development-constraints.md rename to docs/guideline/Constraints.md