Skip to content

Dev:对项目的文档、构建流程和 Web 图形用户界面 (GUI) 进行了多项改进和更新。#19

Merged
BlueSkyXN merged 5 commits intomainfrom
dev
Feb 6, 2026
Merged

Dev:对项目的文档、构建流程和 Web 图形用户界面 (GUI) 进行了多项改进和更新。#19
BlueSkyXN merged 5 commits intomainfrom
dev

Conversation

@BlueSkyXN
Copy link
Owner

This pull request introduces several improvements and updates across the documentation, build workflows, and the web GUI for the project. The most significant changes include a major expansion and restructuring of the architecture documentation to cover the new GUI control panel, updates to the build workflows for better accuracy and asset handling, and enhancements to the web interface for clarity and usability.

Documentation updates and GUI control panel integration:

  • The architecture documentation (docs/ARCH.md) is significantly expanded and reorganized to provide detailed descriptions of the system's four-layer component architecture, data flow, communication protocols, and the new GUI control panel. It now includes diagrams, startup commands, and detailed explanations of each component's responsibilities. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]
  • The configuration documentation (docs/CONFIG.md) adds a new section on GUI control panel configuration, detailing startup parameters, environment variables, progress file handling, and API references. [1] [2]

Build workflow improvements:

  • The build workflows for Nuitka and PyInstaller are updated to include the workflow files themselves as triggers for the build, ensuring changes to these files will rerun the workflows. [1] [2]
  • The PyInstaller workflow now removes frontend assets (web/dist) for CLI-only builds to prevent unnecessary inclusion, and updates artifact naming and documentation to clarify supported platforms. [1] [2] [3] [4]

Web GUI enhancements:

  • The main navigation tab previously labeled "logs" is renamed to "monitor" for better clarity. [1] [2]
  • The configuration sidebar adds a dedicated section and icon for "Token Estimation," improving discoverability and organization. [1] [2] [3] [4]
  • The raw YAML editor in the web interface receives minor UI improvements, including a border and minimum height for better usability.

These changes collectively improve the clarity, maintainability, and user experience of the project, especially regarding the new GUI control panel and its integration into the overall architecture.

References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23] [24] [25]

BlueSkyXN and others added 5 commits February 5, 2026 17:09
Modify .github/workflows/build-pyinstaller.yml to adjust matrix runners and artifact naming: switch Ubuntu runners from ubuntu-24.04 to ubuntu-22.04, replace ubuntu-24.04-arm entries with macos-13 (Intel) and move macOS ARM builds to macos-14, update Windows runner from windows-2025 to windows-2022, and update artifact names to reflect macOS (Intel/Apple Silicon) builds. Also remove the global build_type matrix in favor of explicit include entries. These changes align the workflow with supported runners and correct platform artifact labels.
Add each workflow YAML to its own push path filter so edits to the workflow files will trigger runs. Updated .github/workflows/build-nuitka.yml and .github/workflows/build-pyinstaller.yml to include their respective filenames in the 'paths' list under on: push, ensuring CI runs when workflow definitions change.
Modify .github/workflows/build-pyinstaller.yml to update runner targets and artifacts: bump Ubuntu from 22.04 to 24.04, add an ubuntu-24.04-arm entry (replacing macOS 13) and use linux-arm64 artifact names, bump macOS to 15, and update Windows runner from 2022 to 2025. Changes apply to both the full and cli-only build matrix entries.
…e Raw YAML editor (#18)

* Initial plan

* Fix Web UI issues: rename Logs to Monitor, add Token Estimation section, improve Raw YAML editor

Co-authored-by: BlueSkyXN <63384277+BlueSkyXN@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: BlueSkyXN <63384277+BlueSkyXN@users.noreply.github.com>
Add comprehensive docs for the new GUI control panel and control layer. ARCH.md now describes a four-component architecture (GUI, Control, Gateway, Process), interaction diagrams, HTTP/WebSocket endpoints, subprocess management, progress-file format (.dataflux_progress.json), startup commands, updated project layout (src/control, web/), CLI changes (cmd_gui), and new tests. CONFIG.md adds a GUI control panel section with startup args, environment variables, progress file rules, examples, and links to the GUI API. These changes document how to run, configure and monitor the GUI, gateway and process components.
Copilot AI review requested due to automatic review settings February 6, 2026 04:29
@BlueSkyXN BlueSkyXN merged commit 043c68a into main Feb 6, 2026
20 checks passed
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request enhances the project's documentation, build workflows, and web GUI to support the newly integrated GUI control panel feature. The changes improve user experience through better UI organization, clearer documentation, and streamlined build processes.

Changes:

  • Renamed "logs" tab to "monitor" across the web interface for better clarity
  • Extracted token estimation configuration into a dedicated UI section with its own sidebar entry
  • Added comprehensive GUI control panel documentation to CONFIG.md and ARCH.md
  • Updated build workflows to include workflow files as triggers and improved artifact handling

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
web/src/types.ts Updated TabType to replace 'logs' with 'monitor'
web/src/i18n.ts Updated translations for the renamed monitor tab in both English and Chinese
web/src/components/config/sections/TokenSection.tsx New component for token estimation configuration
web/src/components/config/sections/PromptSection.tsx Removed token estimation section (moved to TokenSection)
web/src/components/config/SectionRenderer.tsx Added routing for the new TokenSection component
web/src/components/config/RawYamlEditor.tsx Improved UI with border and minimum height for better usability
web/src/components/config/ConfigSidebar.tsx Added token section to sidebar with dedicated icon
web/src/App.tsx Updated tab references from 'logs' to 'monitor'
docs/CONFIG.md Added GUI control panel configuration section with startup parameters, environment variables, and progress file details
docs/ARCH.md Expanded architecture documentation with four-component interaction diagrams, data flow descriptions, and communication protocols
.github/workflows/build-pyinstaller.yml Added workflow file as trigger, improved CLI-only build asset handling, updated documentation
.github/workflows/build-nuitka.yml Added workflow file as trigger for consistency

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


**PROJECT_ROOT 计算规则**:
1. 环境变量 `DATAFLUX_PROJECT_ROOT` 或 `AI_DATAFLUX_PROJECT_ROOT`(最高优先级)
2. 源码模式:仓库根目录(当前为 `/Users/sky/GitHub/AI-DataFlux`)
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line contains a hardcoded path specific to the developer's machine (/Users/sky/GitHub/AI-DataFlux). This should be replaced with a placeholder or generic example path like /path/to/AI-DataFlux or <repository-root> to make the documentation more universally applicable.

Suggested change
2. 源码模式:仓库根目录(当前为 `/Users/sky/GitHub/AI-DataFlux`
2. 源码模式:仓库根目录(例如 `/path/to/AI-DataFlux`

Copilot uses AI. Check for mistakes.
```python
# 优先级顺序
1. 环境变量: DATAFLUX_PROJECT_ROOT / AI_DATAFLUX_PROJECT_ROOT
2. 源码模式: 仓库根目录(/Users/sky/GitHub/AI-DataFlux)
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line contains a hardcoded path specific to the developer's machine (/Users/sky/GitHub/AI-DataFlux). This should be replaced with a placeholder or generic example like <repository-root> or /path/to/AI-DataFlux to make the documentation universally applicable.

Suggested change
2. 源码模式: 仓库根目录(/Users/sky/GitHub/AI-DataFlux)
2. 源码模式: 仓库根目录(如 /path/to/AI-DataFlux)

Copilot uses AI. Check for mistakes.
**完整版(Full - 包含 Web GUI):**
- **Linux (x64)**: `AI-DataFlux-linux-amd64-full`
- **Linux (ARM64)**: `AI-DataFlux-linux-arm64-full`
- **macOS (Intel)**: `AI-DataFlux-macos-amd64-full`
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation lists macOS (Intel) builds (AI-DataFlux-macos-amd64-full and AI-DataFlux-macos-amd64-cli), but there is no corresponding matrix entry for macOS Intel in the workflow. The matrix only includes macos-15 (Apple Silicon/ARM64). Either add the missing macOS Intel build matrix entries (e.g., using macos-13 or macos-14 runners), or remove the macOS Intel references from the documentation to match the actual build matrix.

Copilot uses AI. Check for mistakes.
**CLI 版本(仅命令行,体积更小):**
- **Linux (x64)**: `AI-DataFlux-linux-amd64-cli`
- **Linux (ARM64)**: `AI-DataFlux-linux-arm64-cli`
- **macOS (Intel)**: `AI-DataFlux-macos-amd64-cli`
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation lists macOS (Intel) build AI-DataFlux-macos-amd64-cli, but there is no corresponding matrix entry for macOS Intel in the workflow. The matrix only includes macos-15 (Apple Silicon/ARM64). Either add the missing macOS Intel build matrix entry (e.g., using macos-13 or macos-14 runner), or remove the macOS Intel reference from the documentation to match the actual build matrix.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments