Files
prompt-optimizer/docs/examples
linshen 9a4de02438 feat: 完成上下文编辑器重构、组件清理与文档整合
此次提交整合了上下文编辑器的大规模重构、废弃组件的清理以及workspace文档的更新,旨在提升系统性能、代码可维护性和开发体验。

### 主要更新
- **上下文编辑器重构**:
    - 移除 ConversationMessageEditor, ConversationSection 等废弃组件。
    - 清理 ConversationManager 和 ContextEditor 未使用的 props。
    - 实现无障碍功能增强和焦点管理。
    - 创建新的工具 composables 和组件类型。
    - 添加全面的测试覆盖和性能监控。

- **组件与代码清理**:
    - 移除重构前的 `VariableManager.vue` 组件及其导出(497行),由 `VariableManagerModal.vue` 替代。
    - 删除已废弃的 `AdvancedTestPanel.vue` 组件及其导出,已被 `TestAreaPanel` 统一组件完全替代。
    - 清理未使用的 `VariableImportExport.vue` 组件、相关测试文件和类型定义。
    - 遵循 YAGNI 原则,确保移除的组件在任何地方均未被使用。
    - 构建包大小减少约 55KB(3552KB -> 3497KB)。

- **Workspace文档整合**:
    - 归档完整的 Naive UI 迁移项目 (包含8个综合文档)。
    - 补充上下文编辑器重构缺失的spec工作流文档。
    - 建立 `docs/examples/` 目录提供配置模板。
    - 更新归档 `INDEX.md` 多维度快速查找索引。
    - 清理 workspace 目录中15个重复文档。

### 技术改进与优化
- 优化 Git 配置,将 `tsconfig.tsbuildinfo` 从追踪中移除并增强 `.gitignore` 规则覆盖所有 `tsbuildinfo` 文件。
- 添加高级 TypeScript 类型和组件接口,实现工具调用显示和变量导入导出组件。
- 增强变量管理与编辑器集成,并保持 `VariableManager.ts` 服务层(仍在使用)。
- 添加全面的单元测试和e2e测试覆盖,改进开发文档和API指南。
- 所有现有功能完整性验证通过,无构建错误或运行时错误。
2025-09-06 23:45:42 +08:00
..

配置示例文件

本目录包含各种服务和工具的配置示例文件,用于帮助开发者快速配置项目。

📁 文件说明

API 配置示例

  • openai.example.json - OpenAI API 配置示例

    • 包含API密钥、模型参数等配置
    • 用于设置OpenAI服务集成
  • langfuse.example.json - Langfuse 配置示例

    • 用于配置Langfuse追踪和分析服务
    • 包含项目密钥和端点设置

🚀 使用方法

  1. 复制示例文件:将需要的示例文件复制到项目根目录

    cp docs/examples/openai.example.json .env.local
    # 或者根据项目配置要求调整文件名和位置
    
  2. 填写实际配置:根据示例文件中的注释填写真实的API密钥和配置值

  3. 环境变量配置:某些配置可能需要设置为环境变量

    export OPENAI_API_KEY="your_actual_api_key"
    export LANGFUSE_PROJECT_KEY="your_project_key"
    

⚠️ 安全提醒

  • 不要提交真实密钥:确保不将包含真实API密钥的配置文件提交到版本控制
  • 使用环境变量:推荐使用环境变量存储敏感配置
  • 检查.gitignore:确保敏感配置文件已添加到.gitignore中

🔗 相关文档

  • 项目配置指南:查看项目根目录的README.md
  • API集成文档:查看对应的服务集成文档
  • 环境变量配置:参考.env.example文件

更新时间: 2025-09-09
维护方式: 配置示例应该与实际项目配置保持同步