diff --git a/CHANGELOG.en.md b/CHANGELOG.en.md new file mode 100644 index 0000000000000000000000000000000000000000..37c6c4a417c2e161a6ba50bb0eb5c1576420aafb --- /dev/null +++ b/CHANGELOG.en.md @@ -0,0 +1,28 @@ +# Changelog + +## [0.10.0] - 2025-09-30 + +### Added + +- Choice-branch workflow builder now renders condition paths visually, includes parameter completion prompts, and introduces a full-featured YAML editor with inline validation and formatting. +- Agent debugging dialog embeds the dialogue panel with session history, file previews, and Markdown rendering for richer troubleshooting. +- Dialogue responses surface reference documents with summaries plus download icons across multiple formats. +- MCP service management adds categorized listings, activation toggles, and automatic persistence when selecting services. +- Activation-key entry dialog compatible with legacy localization keys, alongside a pre-publish risk confirmation flow for agents. +- Auto-execution toggle and parameter-supplement modal streamline agent testing workflows. + +### Changed + +- Refreshed localization strings for English and workflow terminology, adding YAML-focused vocabulary and dialogue messaging updates. +- Conversation store refactor improves session synchronization, default titles, and metadata propagation throughout the UI. +- API layer carries expanded payloads for MCP queries, workflow operations, and stop-generation controls. +- UI refinements throughout agent creation, dialogue, and shared footer components with updated styling tokens and layout adjustments. +- Build tooling updates across Dockerfile, RPM specs, and Vite configuration to support 0.10.0 packaging and worker domain settings. + +### Fixed + +- Resolved nginx and CSP configuration issues to allow cross-origin communication and image loading. +- Corrected workflow connector behaviour, addressing line rendering, edit errors, and choice-path highlighting bugs. +- Patched MCP config display issues and application status interaction regressions in the service management views. +- Ensured knowledge-base removals refresh immediately and agent metadata fields display correctly. +- Fixed production runtime errors and dialogue height regressions observed in the previous release. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000000000000000000000000000000000..92c7e82f2479991641ac8d22dc8a4b718ebd1a11 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,28 @@ +# 更新日志 + +## [0.10.0] - 2025-09-30 + +### 新增 + +- Choice 分支工作流构建器支持条件路径可视化、参数补全提示，并提供具备内联校验和格式化的 YAML 编辑器。 +- Agent 调试弹窗集成对话面板，展示会话历史、文件预览和 Markdown 渲染，便于排查问题。 +- 对话回复支持展示引用文档摘要，并提供多格式下载图标。 +- MCP 服务管理增加分类列表、激活开关，以及选择服务时的自动持久化。 +- 新增兼容旧版国际化键值的激活密钥输入弹窗，并在 Agent 发布前加入风险提示确认流程。 +- 自动执行开关与参数补充弹窗优化 Agent 调试体验。 + +### 优化 + +- 全面更新英文与工作流相关的本地化文案，补充 YAML 关键字和对话提示。 +- 会话存储重构，改进会话同步、默认标题与元数据透传。 +- API 层扩展 MCP 查询、工作流操作与停止生成的请求载荷。 +- Agent 创建、对话及通用页脚等界面样式调整，采用新的样式变量和布局优化。 +- 构建工具链同步 0.10.0，包含 Dockerfile、RPM 规格以及 Vite Worker 域名设置。 + +### 修复 + +- 解决 nginx 与 CSP 配置导致的跨域通信和图片加载问题。 +- 修复工作流连接异常，覆盖连线渲染、编辑报错与分支路径高亮。 +- 修复 MCP 配置展示异常及服务管理界面状态交互问题。 +- 修复知识库移除后未及时刷新及 Agent 元数据字段显示错误。 +- 修复此前版本出现的生产运行错误与对话高度异常。 diff --git a/README.en.md b/README.en.md index 3d4d756321eaf4cd571c3dc2591bbfd68ca66a31..e3f4658acaae846d463ed1df6e9480316faea4ab 100644 --- a/README.en.md +++ b/README.en.md @@ -1,36 +1,89 @@ -# euler-copilot-web +# openEuler Intelligence Web -#### Description -openEuler Intelligence前端 +openEuler Intelligence Web provides the unified front-end experience for openEuler's intelligence platform across web browsers and Electron desktop apps, featuring model interaction, knowledge retrieval, and an application center for extended tooling. -#### Software Architecture -Software architecture description +## Features -#### Installation +- Intelligent chat: orchestrates multiple models via the [openEuler Intelligence agent framework](https://gitee.com/openeuler/euler-copilot-framework) to support multi-turn conversations and context management. +- Knowledge retrieval: connects to the openEuler documentation corpus to deliver search and summarization. +- Application center: exposes workflows, toolchains, and plugin entry points to extend intelligence scenarios. +- Multi-surface delivery: ships a Vite + Vue 3 web UI and packages it as an Electron desktop application. +- Internationalization: ships with Chinese and English locales and switches automatically based on user language. -1. xxxx -2. xxxx -3. xxxx +## Tech Stack -#### Instructions +- Runtime: Vue 3, Pinia, Vue Router, Element Plus, ECharts +- Development tooling: Vite, TypeScript, Sass +- Build & scripts: pnpm, TS Node, Rollup, Electron Builder +- Code quality: ESLint, Prettier, TypeScript type checking -1. xxxx -2. xxxx -3. xxxx +## Prerequisites -#### Contribution +- Node.js >= 22.14.0 +- pnpm 10.14.0 (see the [pnpm installation guide](https://pnpm.io/installation)) +- macOS, Linux, or Windows development environment -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request +## Getting Started +```bash +# Install dependencies +pnpm install -#### Gitee Feature +# Run only the web renderer (defaults to http://localhost:5173) +pnpm run dev -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +# Collaboratively develop the desktop app (main/preload/welcome) +pnpm run dev:desktop + +# Build the production web bundle +pnpm run build + +# Build the full desktop artifacts (output in dist/) +pnpm run build:desktop +``` + +Common debugging scripts: + +- `pnpm run dev:main`: transpile the Electron main process with watch mode. +- `pnpm run dev:preload`: rebuild Electron preload scripts on file changes. +- `pnpm run dev:welcome`: watch and rebuild the desktop welcome screen. +- `pnpm run preview`: preview the production build locally. + +## Project Structure + +```text +├─ src/ # Web renderer code (Vue components, router, store, utilities) +├─ electron/ # Electron main process, preload scripts, welcome screens +├─ build/ # Build configuration, installer templates, RPM specs +├─ scripts/ # TypeScript build utilities and helpers +├─ docs/ # Developer documentation (desktop configuration, etc.) +├─ public/ # Static assets and HTML templates +└─ release/ # Pre-built desktop/web packages and offline dependencies +``` + +## Configuration + +- `env.d.ts` / `src/conf`: environment variable typings and runtime configuration references. +- `deploy/`: Nginx templates and startup scripts for deployment. +- `build/scripts/*.sh`: helper scripts for RPM packaging and offline dependency preparation. + +## Quality Gates + +- `pnpm run lint`: auto-fix most ESLint rules. +- `pnpm run format`: run Prettier on `src/`, `electron/`, and `scripts/`. +- `pnpm run type-check`: execute TypeScript static checks. + +## Contributing + +We welcome issues and pull requests to improve openEuler Intelligence Web: + +1. Fork the repository and create a feature branch (recommended naming `feat/`). +2. Make changes with clear descriptions and ensure linting and type checks pass. +3. Open a pull request and include relevant testing or verification notes. +4. Join the code review and respond to feedback promptly. + +Documentation enhancements, UX feedback, and bug reports are also appreciated—please include reproduction steps and environment details in issues to speed up triage. + +## License + +This project is licensed under [Mulan PSL v2](LICENSE). You are welcome to use and extend it under the terms of the license. diff --git a/README.md b/README.md index 143183324e3b8162f11ef1f88b2bf4669cf86755..65687366f161ba151ad86663cfb06ff9c01a3f57 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,89 @@ -# euler-copilot-web +# openEuler Intelligence Web -#### 介绍 -openEuler Intelligence前端 +openEuler Intelligence Web 是 openEuler 社区智能化体验的 Web 与桌面端统一前端，提供模型互动、知识检索与应用中心等能力，并兼容浏览器部署与 Electron 桌面应用形态。 -#### 软件架构 -软件架构说明 +## 功能特性 +- 智能对话：通过 [openEuler Intelligence 智能体框架](https://gitee.com/openeuler/euler-copilot-framework) 汇聚多模型能力，支持多轮问答与上下文管理。 +- 知识检索：对接 openEuler 文档与知识库，提供搜索与摘要能力。 +- 应用中心：提供工作流、工具链和插件入口，便于扩展智能化方案。 +- 多端形态：基于 Vite + Vue 3 构建 Web 端界面，并通过 Electron 打包桌面应用。 +- 国际化支持：内置中英文语言包，可根据用户语言自动切换。 -#### 安装教程 +## 技术栈 -1. xxxx -2. xxxx -3. xxxx +- 运行时：Vue 3、Pinia、Vue Router、Element Plus、ECharts +- 开发框架：Vite、TypeScript、Sass +- 构建与脚本：pnpm、TS Node、Rollup、Electron Builder +- 代码质量：ESLint、Prettier、TypeScript 类型检查 -#### 使用说明 +## 环境要求 -1. xxxx -2. xxxx -3. xxxx +- Node.js >= 22.14.0 +- pnpm 10.14.0（安装见 [pnpm 官方说明](https://pnpm.io/installation)） +- macOS、Linux 或 Windows 开发环境 -#### 参与贡献 +## 快速开始 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +```bash +# 安装依赖 +pnpm install +# 仅运行 Web 渲染进程（默认 http://localhost:5173） +pnpm run dev -#### 特技 +# 与 Electron 主进程/预加载/欢迎页协作开发桌面端 +pnpm run dev:desktop -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +# 构建 Web 产物 +pnpm run build + +# 构建桌面端完整产物（生成于 dist/） +pnpm run build:desktop +``` + +常用调试脚本： + +- `pnpm run dev:main`：Electron 主进程 TS -> JS 热编译。 +- `pnpm run dev:preload`：Electron 预加载脚本实时构建。 +- `pnpm run dev:welcome`：桌面欢迎页构建与监听。 +- `pnpm run preview`：在本地以生产配置预览构建结果。 + +## 项目结构 + +```text +├─ src/ # Web 渲染进程源码（Vue 组件、路由、状态、工具等） +├─ electron/ # Electron 主进程、预加载脚本与桌面欢迎页 +├─ build/ # 构建配置、桌面安装器模版与 RPM 规范 +├─ scripts/ # TS 构建脚本与通用工具 +├─ docs/ # 开发者文档（桌面配置说明等） +├─ public/ # 静态资源与 HTML 模版 +└─ release/ # 预构建桌面/Web 安装包与离线依赖 +``` + +## 配置与环境 + +- `env.d.ts` / `src/conf`：环境变量类型声明与运行时配置说明。 +- `deploy/`：部署所需的 Nginx 配置及启动脚本。 +- `build/scripts/*.sh`：RPM 打包、离线依赖准备等辅助脚本。 + +## 质量与校验 + +- `pnpm run lint`：自动修复大部分 ESLint 规则。 +- `pnpm run format`：对 `src/`、`electron/`、`scripts/` 执行 Prettier。 +- `pnpm run type-check`：运行 TypeScript 静态类型检查。 + +## 贡献指南 + +欢迎通过 Issue 与 Pull Request 为 openEuler Intelligence Web 做出贡献： + +1. Fork 仓库并创建特性分支（推荐命名 `feat/`）。 +2. 提交包含必要说明的变更，确保通过 lint 与类型检查。 +3. 提交 Pull Request，并补充相关测试或调试步骤说明。 +4. 参与代码评审，及时响应维护者反馈。 + +我们同时欢迎文档改进、体验反馈与 Bug 报告，可在 Issue 中附带重现步骤与环境信息，加速问题定位。 + +## 开源许可证 + +本项目遵循 [Mulan PSL v2](LICENSE) 开源许可证。欢迎在遵循协议的前提下使用与二次开发。